Files
atxp-dev__cli/README.md
T
Rob Di Marco 724821fe97 Add configurable port and directory options for demo command (#2)
- Move argument parsing from run-demo.ts to index.ts for better separation of concerns
- Add --port/-p option to specify custom demo port (default: 8016)
- Add --dir/-d option to specify custom demo directory (default: ~/.cache/atxp/demo)
- Refactor runDemo() to accept DemoOptions parameter for type safety
- Update all helper functions to use passed parameters instead of global state
- Add comprehensive documentation in help text and README files
- Support path resolution for relative directory paths

New usage examples:
- npx atxp demo --port 3000
- npx atxp demo --dir ./my-demo
- npx atxp demo --port 9000 --dir ~/projects/demo --verbose

Resolves port conflicts and allows flexible demo installation locations.

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

Co-authored-by: Claude <noreply@anthropic.com>
2025-09-09 13:43:48 -04:00

1.9 KiB

ATXP CLI

Command line tools for the ATXP ecosystem - create projects and run demos.

About ATXP

ATXP is a platform for building web agents with OAuth and payment capabilities. The CLI helps you:

  • Create new projects with ATXP integration
  • Set up development environments quickly
  • Run interactive demos to explore ATXP features

Packages

This monorepo contains:

  • atxp - Main CLI package for creating projects and running demos
  • create-atxp - Wrapper package for npm create atxp support

Commands

  • npx atxp - Show help and available commands
  • npx atxp demo - Run the interactive demo application
  • npx atxp create - Create a new ATXP project
  • npx atxp help - Display help information

Demo Options

  • --verbose, -v - Show detailed logs
  • --refresh - Force refresh demo from GitHub
  • --port, -p - Specify port number (default: 8016)
  • --dir, -d - Specify demo directory (default: ~/.cache/atxp/demo)

Examples

Get Started

# Show available commands and help
npx atxp

Try the Demo

# Run the interactive demo
npx atxp demo

# Run with detailed output  
npx atxp demo --verbose

# Use custom port
npx atxp demo --port 3000

# Use custom directory
npx atxp demo --dir ./my-demo

# Combine options
npx atxp demo --port 3000 --dir ./my-demo --verbose

# Force refresh from GitHub
npx atxp demo --refresh

Create a New Project

# Create a new project
npx atxp create my-app

# Alternative method
npm create atxp my-app

# Set up the project
cd my-app
npm install
npm start

Development

Install dependencies:

npm install

Build all packages:

npm run build

Test the CLI locally:

cd packages/atxp
npm run dev

Publishing

Each package is published independently:

cd packages/atxp
npm publish

cd ../create-atxp  
npm publish

License

MIT