Skip to content

More docs#6

Merged
mosquito merged 2 commits into
masterfrom
fetaure/more-docs
May 18, 2026
Merged

More docs#6
mosquito merged 2 commits into
masterfrom
fetaure/more-docs

Conversation

@mosquito
Copy link
Copy Markdown
Collaborator

This pull request significantly expands and clarifies the documentation for several ConTree CLI commands. The main improvements include the addition of detailed subcommand sections, more comprehensive usage explanations, and embedded help command outputs for easier reference. The documentation now better explains command behaviors, available flags, and expected outputs, making it more user-friendly for both new and experienced users.

Major documentation improvements:

Authentication commands (auth):

  • Expanded the auth list section to clarify aliases, status values, and the effect of the --offline flag. Added embedded help output.
  • Added new section for auth switch explaining how to change the active profile, with help output.
  • Enhanced auth remove documentation to describe its behavior, confirmation, and side effects when removing the active profile. Added help output.

File management commands (file):

  • Expanded documentation for file edit and file cp to clarify their behavior, aliases, and staging mechanism. Added help output for both.
  • Added help output for file ls.

Image management commands (images):

  • Added new subcommands section with detailed docs and help outputs for images list and images import.

Operation management commands (op):

  • Clarified that op is a dispatcher and added detailed sections for op list, op show, and op cancel, each with help output and explanation of dynamic columns and filtering. [1] [2] [3]

Session management commands (session):

  • Added comprehensive subcommands section covering session list, use, branch, checkout, rollback, show, wait, and delete, each with usage explanations and help outputs.

Skill management commands (skill):

  • Expanded the spec format table to cover new skill kinds and clarify resolution logic.
  • Added a subcommands section with detailed documentation for skill install, list, upgrade, and remove, including behavior, registry management, and help outputs.

These changes greatly improve the discoverability and clarity of CLI features, making the documentation more actionable and easier to navigate for end users.

@mosquito mosquito merged commit 273e96f into master May 18, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant