The Phylax Credible CLI (PCL) is a command-line interface for interacting with the Credible Layer. It allows developers to authenticate, build, test, and submit assertions to the Credible Layer dApp.
- Phylax Credible Layer (PCL) CLI
- It requires Rust >= 1.80
- Run
cargo install --git https://github.com/phylaxsystems/pcl
Before using most commands, you need to authenticate:
pcl auth [OPTIONS] <COMMAND>
Commands:
login Login to PCL using your wallet
logout Logout from PCL
status Check current authentication status
Options:
--base-url <BASE_URL> Base URL for authentication service [env: AUTH_BASE_URL=] [default: https://credible-layer-dapp.pages.dev]
-h, --help Print helpWhen logging in:
- A URL and authentication code will be displayed
- Visit the URL in your browser
- Connect your wallet and approve the authentication
- CLI will automatically detect successful authentication
Manage your PCL configuration:
pcl config [COMMAND]
Commands:
show Display the current configuration
delete Delete the current configurationConfiguration is stored in ~/.pcl/config.toml and includes:
- Authentication token
- Pending assertions for submission
- Project settings
Run tests using Phorge (a Forge-compatible development environment). It's a minimal fork of forge to support out assertion execution cheatcodes, so pcl test behaves identically to forge test.
pcl test -h
Run tests using Phorge
Usage: pcl test [OPTIONS] [PATH]
Options:
-h, --help Print help (see more with '--help')
Display options:
-v, --verbosity... Verbosity level of the log messages.
-q, --quiet Do not print log messages
--json Format log messages as JSON
--color <COLOR> The color of the log messages [possible values: auto, always, never]
-s, --suppress-successful-traces Suppress successful test traces and show only traces for failures [env: FORGE_SUPPRESS_SUCCESSFUL_TRACES=]
--junit Output test results as JUnit XML report
-l, --list List tests instead of running them
--show-progress Show test execution progress
--summary Print test summary table
--detailed Print detailed test summary table
... // rest of the `forge test` help outputpcl store [OPTIONS] <ASSERTION_CONTRACT> [CONSTRUCTOR_ARGS]...
Arguments:
<ASSERTION_CONTRACT> Name of the assertion contract to build and flatten
[CONSTRUCTOR_ARGS]... Constructor arguments for the assertion contract
Options:
-u, --url <URL> URL of the assertion-DA server [default: http://localhost:5001]
-r, --root <ROOT> Root directory of the project
-h, --help Print help (see a summary with '-h')pcl submit [OPTIONS]
Options:
-u, --dapp-url <DAPP_URL> Base URL for the Credible Layer dApp API [default: http://localhost:3003/api/v1]
-p, --project-name <PROJECT_NAME> Optional project name to skip interactive selection
-a, --assertion-keys <ASSERTION_KEYS> Optional list of assertion name and constructor args to skip interactive selection
Format: assertion_name OR 'assertion_name(constructor_arg0,constructor_arg1)'
-h, --help Print help# Login
pcl auth login
# Verify status
pcl auth status
# Store assertion
pcl store my_assertion
# Submit to dApp
pcl submit -a my_assertion -p my_project
# Logout when done
pcl auth logout# Run tests
pcl test
# Store and submit assertion
pcl store my_assertion
pcl submit -a my_assertion -p my_project- Error: Not authenticated: Run
pcl auth loginto authenticate - Error: Authentication expired: Run
pcl auth loginto refresh your authentication - Browser doesn't open: Manually visit the URL displayed in the terminal
- Error: Failed to submit: Ensure you're authenticated and have network connectivity
- Error: Project not found: Create a project in the Credible Layer dApp first
- Error: Assertion not found: Ensure the assertion name is correct and exists in your project
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
# Install dependencies
cargo build
# Run tests
make test
# Check formatting
make format-check
# Run linter
make lint