docs(cli): rewrite README, add command reference and agent skill#176
Merged
docs(cli): rewrite README, add command reference and agent skill#176
Conversation
- Rewrite README.md as concise npm entry page (no emojis, no deprecated commands) - Add docs/ with per-command reference pages (23 files) - Add skill/phala-cli/ agent skill with SKILL.md and references/
…precated - Group commands table by category matching `phala --help` (Deploy, Manage, CVM Operations, Profile/Auth, Advanced) - Add `phala link` to Quick Start with tip about phala.toml being safe to commit - Remove deprecated commands (auth, config, docker) from README
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
- Move phala-cli skill from cli/skill/ to skills/ (shared location for future skills) - Add best practices: phala.toml workflow (link, commit, team usage) - Add log debugging guide: container → serial → cvm-stderr escalation path
Replace reference-heavy command table with intent-driven procedures: - Intent mapping table (user says X → operation Y) - Step-by-step flows: first deploy, update, debug, SSH, CI/CD - Debug escalation path with serial log failure table - Gotchas table with real operational pitfalls - No duplication of references/commands.md content
Operational checklist for docker-compose.yml and Docker build before deploying to Phala Cloud CVMs. Covers: - Single-file constraint (no external references) - 200KB combined size limit - amd64 architecture requirement (Intel TDX) - Image accessibility and registry credentials - Secrets leakage detection - TEE volume mount (dstack.sock) - Port/network sanity
Collaborator
Author
|
!release cli patch |
Contributor
|
🚀 @Leechael release command accepted: Target branch: |
Contributor
|
🎉 Release completed:
📦 Package Info
📄 Files included |
pacoyang
approved these changes
Feb 12, 2026
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
2 participants
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.
Summary
cli/README.mdas concise npm entry page — no emojis, no deprecated commands (auth login,cvms create), no Commander.js referencescli/docs/with 23 per-command reference pages covering all current commandscli/skill/phala-cli/agent skill (SKILL.md + references/) for Claude/AI assistant integrationDetails
README.md — npm-facing entry guide with: Install, Quick Start, Commands table (linked to docs/), Configuration (phala.toml, env vars, profiles), Development, License.
docs/ — each command gets a dedicated reference page with Usage, Arguments, Options, Examples. Group commands (cvms, docker, simulator, config) have all subcommands in one file. Deprecated commands noted with migration paths.
skill/ —
phala-cliagent skill with:SKILL.md— command overview, common workflows, key conceptsreferences/commands.md— condensed full command referencereferences/configuration.md— phala.toml, env vars, profiles, private registriesreferences/troubleshooting.md— deploy error codes, auth/SSH/log debuggingTest plan
namematches directory name