-
Notifications
You must be signed in to change notification settings - Fork 297
Fix CLI consistency: remove emojis from help strings, fix apm config invocation, update descriptions
#212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Fix CLI consistency: remove emojis from help strings, fix apm config invocation, update descriptions
#212
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -310,7 +310,7 @@ def cli(ctx): | |
| cli.add_command(deps) | ||
|
|
||
|
|
||
| @cli.command(help="🚀 Initialize a new APM project") | ||
| @cli.command(help="Initialize a new APM project") | ||
| @click.argument("project_name", required=False) | ||
| @click.option( | ||
| "--yes", "-y", is_flag=True, help="Skip interactive prompts and use auto-detected defaults" | ||
|
|
@@ -635,7 +635,7 @@ def _validate_package_exists(package): | |
|
|
||
|
|
||
| @cli.command( | ||
| help="📦 Install APM and MCP dependencies (auto-creates apm.yml when installing packages)" | ||
| help="Install APM and MCP dependencies (auto-creates apm.yml when installing packages)" | ||
| ) | ||
| @click.argument("packages", nargs=-1) | ||
| @click.option("--runtime", help="Target specific runtime only (copilot, codex, vscode)") | ||
|
|
@@ -972,7 +972,7 @@ def prune(ctx, dry_run): | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @cli.command(help="⬆️ Update APM to the latest version") | ||
| @cli.command(help="Update APM to the latest version") | ||
| @click.option("--check", is_flag=True, help="Only check for updates without installing") | ||
| def update(check): | ||
| """Update APM CLI to the latest version (like npm update -g npm). | ||
|
|
@@ -1099,7 +1099,7 @@ def update(check): | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @cli.command(help="Remove APM packages from apm.yml and apm_modules") | ||
| @cli.command(help="Remove APM packages, their integrated files, and apm.yml entries") | ||
| @click.argument("packages", nargs=-1, required=True) | ||
| @click.option( | ||
| "--dry-run", is_flag=True, help="Show what would be removed without removing" | ||
|
|
@@ -3922,7 +3922,7 @@ def _recompile(self, changed_file): | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @cli.command(help="🚀 Compile APM context into distributed AGENTS.md files") | ||
| @cli.command(help="Compile APM context into distributed AGENTS.md files") | ||
| @click.option( | ||
| "--output", | ||
| "-o", | ||
|
|
@@ -3939,7 +3939,7 @@ def _recompile(self, changed_file): | |
| @click.option( | ||
| "--dry-run", | ||
| is_flag=True, | ||
| help="🔍 Preview compilation without writing files (shows placement decisions)", | ||
| help="Preview compilation without writing files (shows placement decisions)", | ||
| ) | ||
| @click.option("--no-links", is_flag=True, help="Skip markdown link resolution") | ||
| @click.option("--chatmode", help="Chatmode to prepend to AGENTS.md files") | ||
|
|
@@ -3955,23 +3955,23 @@ def _recompile(self, changed_file): | |
| @click.option( | ||
| "--single-agents", | ||
| is_flag=True, | ||
| help="📄 Force single-file compilation (legacy mode)", | ||
| help="Force single-file compilation (legacy mode)", | ||
| ) | ||
| @click.option( | ||
| "--verbose", | ||
| "-v", | ||
| is_flag=True, | ||
| help="🔍 Show detailed source attribution and optimizer analysis", | ||
| help="Show detailed source attribution and optimizer analysis", | ||
| ) | ||
| @click.option( | ||
| "--local-only", | ||
| is_flag=True, | ||
| help="🏠 Ignore dependencies, compile only local primitives", | ||
| help="Ignore dependencies, compile only local primitives", | ||
| ) | ||
| @click.option( | ||
| "--clean", | ||
| is_flag=True, | ||
| help="🧹 Remove orphaned AGENTS.md files that are no longer generated", | ||
| help="Remove orphaned AGENTS.md files that are no longer generated", | ||
| ) | ||
| @click.pass_context | ||
| def compile( | ||
|
|
@@ -4421,7 +4421,7 @@ def compile( | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @cli.group(help="Configure APM CLI") | ||
| @cli.group(help="Configure APM CLI", invoke_without_command=True) | ||
| @click.pass_context | ||
| def config(ctx): | ||
| """Configure APM CLI settings.""" | ||
|
Comment on lines
4423
to
4427
|
||
|
|
@@ -4706,7 +4706,7 @@ def list(): | |
|
|
||
| @runtime.command(help="Remove an installed runtime") | ||
| @click.argument("runtime_name", type=click.Choice(["copilot", "codex", "llm"])) | ||
| @click.confirmation_option(prompt="Are you sure you want to remove this runtime?") | ||
| @click.confirmation_option(prompt="Are you sure you want to remove this runtime?", help="Confirm the action without prompting") | ||
| def remove(runtime_name): | ||
| """Remove an installed runtime from APM management.""" | ||
| try: | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,7 +22,7 @@ def deps(): | |
| pass | ||
|
|
||
|
|
||
| @deps.command(name="list", help="📋 List installed APM dependencies") | ||
| @deps.command(name="list", help="List installed APM dependencies") | ||
| def list_packages(): | ||
| """Show all installed APM dependencies with context files and agent workflows.""" | ||
| try: | ||
|
|
@@ -229,7 +229,7 @@ def list_packages(): | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @deps.command(help="🌳 Show dependency tree structure") | ||
| @deps.command(help="Show dependency tree structure") | ||
|
||
| def tree(): | ||
| """Display dependencies in hierarchical tree format using lockfile.""" | ||
| try: | ||
|
|
@@ -389,7 +389,7 @@ def _add_children(parent_branch, parent_repo_url, depth=0): | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @deps.command(help="🧹 Remove all APM dependencies") | ||
| @deps.command(help="Remove all APM dependencies") | ||
| def clean(): | ||
| """Remove entire apm_modules/ directory.""" | ||
| project_root = Path(".") | ||
|
|
@@ -423,7 +423,7 @@ def clean(): | |
| sys.exit(1) | ||
|
|
||
|
|
||
| @deps.command(help="🔄 Update APM dependencies") | ||
| @deps.command(help="Update APM dependencies") | ||
| @click.argument('package', required=False) | ||
| def update(package: Optional[str]): | ||
| """Update specific package or all if no package specified.""" | ||
|
|
@@ -461,7 +461,7 @@ def update(package: Optional[str]): | |
| _update_all_packages(project_deps, apm_modules_path) | ||
|
|
||
|
|
||
| @deps.command(help="ℹ️ Show detailed package information") | ||
| @deps.command(help="Show detailed package information") | ||
| @click.argument('package', required=True) | ||
| def info(package: str): | ||
| """Show detailed information about a specific package including context files and workflows.""" | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The uninstall section summary doesn’t mention that
apm uninstallalso removes entries fromapm.yml(which is part of the command’s behavior and is called out later in the table/behavior list). Consider updating this one-line description to match the more complete scope described elsewhere (and the updated CLI help string).