docs(cli): add comprehensive CLI README documentation and usage guide - #844
Open
onajidavid87-web wants to merge 1 commit into
Open
docs(cli): add comprehensive CLI README documentation and usage guide#844onajidavid87-web wants to merge 1 commit into
onajidavid87-web wants to merge 1 commit into
Conversation
Added cli/README.md to document all available commands, deployment configurations, environment variables, and workflow examples for the @bc-forge/cli Deployment Orchestrator. 🛠️ Key Details & Additions Environment & Config Setup: Documented environment variables (RPC_URL, NETWORK_PASSPHRASE, CONTRACT_ID, SECRET_KEY, STELLAR_CLI_BIN) and .bc-forge.json manifest structure. Command Reference: check-status: Pings configured Soroban contract instances to report reachability, latency, and status (responsive, not_deployed, unreachable, invalid). upgrade: Submits WASM code upgrades and multi-sig proposals on-chain, including --dry-run simulation flags. verify-hash: SHA-256 diffing between local WASM artifacts and on-chain contract code (contractExecutableWasm). smoke-test: Executes automated end-to-end sanity tests (balance → mint → transfer). generate-bindings: Generates client SDK bindings via Stellar CLI (typescript, rust, python, java, flutter, swift, php). Workflow Examples: Included clear step-by-step code and CLI invocation guides for: Contract Deployment & Status Verification Contract WASM Upgrades (Dry-Run & Live Execution) On-Chain WASM Integrity Verification & Smoke Testing ✅ Verification Ran TypeScript compilation (npm --prefix cli run build): Passed cleanly (tsc -b). Ran CLI unit test suite (npm --prefix cli test): All 72 tests across 6 test files passed successfully. Closes BCPathway#710
|
@onajidavid87-web Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #710
What does this PR do?
Added cli/README.md to document all available commands, deployment configurations, environment variables, and workflow examples for the @bc-forge/cli Deployment Orchestrator.
Environment & Config Setup: Documented environment variables (RPC_URL, NETWORK_PASSPHRASE, CONTRACT_ID, SECRET_KEY, STELLAR_CLI_BIN) and .bc-forge.json manifest structure. Command
Reference:
check-status: Pings configured Soroban contract instances to report reachability, latency, and status (responsive, not_deployed, unreachable, invalid). upgrade: Submits WASM code upgrades and multi-sig proposals on-chain, including --dry-run simulation flags. verify-hash: SHA-256 diffing between local WASM artifacts and on-chain contract code (contractExecutableWasm). smoke-test: Executes automated end-to-end sanity tests (balance → mint → transfer). generate-bindings: Generates client SDK bindings via Stellar CLI (typescript, rust, python, java, flutter, swift, php).
Workflow Examples: Included clear step-by-step code and CLI invocation guides for: Contract Deployment & Status Verification
Contract WASM Upgrades (Dry-Run & Live Execution)
On-Chain WASM Integrity Verification & Smoke Testing
Verification:
Ran TypeScript compilation (npm --prefix cli run build): Passed cleanly (tsc -b). Ran CLI unit test suite (npm --prefix cli test): All 72 tests across 6 test files passed successfully.
Type of change
Checklist
pre-commit run --all-fileslocally and it passedBreaking changes?
No
Related issues
Closes #710