Skip to content

Show help by default instead of running demo#1

Merged
robdimarco-atxp merged 1 commit intomainfrom
robdimarco/atxp-240-running-npx-atxp-should-print-out-help
Sep 9, 2025
Merged

Show help by default instead of running demo#1
robdimarco-atxp merged 1 commit intomainfrom
robdimarco/atxp-240-running-npx-atxp-should-print-out-help

Conversation

@robdimarco-atxp
Copy link
Contributor

Summary

  • Changed default behavior of npx atxp from running demo to showing help
  • Added comprehensive help module with usage examples and command documentation
  • Require explicit npx atxp demo command to run the demo application

Changes

  • New file: src/help.ts - Help display module with CLI documentation
  • Updated: src/index.ts - Modified command parsing to show help by default

Test plan

  • npx atxp now shows help instead of running demo
  • npx atxp help displays help correctly
  • npx atxp demo still runs the demo when explicitly requested
  • npx atxp create continues to work for project creation
  • Invalid commands show proper error messages with help suggestion

Fixes: https://linear.app/novellum/issue/ATXP-240/running-npx-atxp-should-print-out-help

🤖 Generated with Claude Code

- Add comprehensive help module with usage information
- Update CLI to show help when no command is provided
- Require explicit 'demo' command to run the demo
- Add support for help, --help, -h flags
- Improve error handling for unknown commands

Fixes: https://linear.app/novellum/issue/ATXP-240/running-npx-atxp-should-print-out-help

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@linear
Copy link

linear bot commented Sep 9, 2025

ATXP-240 Running `npx atxp` should print out help

if you run npx atxp (with no argument) it currently runs npx atxp demo We want it to instead print out a general help / how-to-use blurb, and the demo should only run if you explicitly do npx atxp demo

@robdimarco-atxp robdimarco-atxp merged commit 9af85f5 into main Sep 9, 2025
1 check passed
@robdimarco-atxp robdimarco-atxp deleted the robdimarco/atxp-240-running-npx-atxp-should-print-out-help branch September 9, 2025 16:57
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