mirror of
https://github.com/atxp-dev/cli.git
synced 2026-09-14 20:46:39 +08:00
emilioacc
e1102aced4
Documents the ATXP skill installation and capabilities for AI assistants. Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
155 lines
3.2 KiB
Markdown
155 lines
3.2 KiB
Markdown
# 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 <app-name>` - 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: 8017)
|
|
- `--dir, -d` - Specify demo directory (default: ~/.cache/atxp/demo)
|
|
|
|
### Create Options
|
|
- `--framework, -f` - Specify framework template (options: express, cloudflare; default: express)
|
|
- `--git` - Force git initialization
|
|
- `--no-git` - Skip git initialization
|
|
|
|
## Examples
|
|
|
|
### Get Started
|
|
```bash
|
|
# Show available commands and help
|
|
npx atxp
|
|
```
|
|
|
|
### Try the Demo
|
|
```bash
|
|
# 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
|
|
```bash
|
|
# Create a new Express project (auto-detects git)
|
|
npx atxp create my-app
|
|
|
|
# Create with Express framework (default)
|
|
npx atxp create my-app --framework express
|
|
|
|
# Create with Cloudflare Workers framework
|
|
npx atxp create my-app --framework cloudflare
|
|
|
|
# Create a new Mastra project
|
|
npx atxp create my-app --framework mastra
|
|
|
|
# Skip git initialization
|
|
npx atxp create my-app --no-git
|
|
|
|
# Force git initialization
|
|
npx atxp create my-app --git
|
|
|
|
# Alternative method using npm create
|
|
npm create atxp my-app
|
|
|
|
# Set up the project
|
|
cd my-app
|
|
npm install
|
|
npm start # For Express projects
|
|
# or
|
|
npm start # For Cloudflare projects (runs vite dev)
|
|
```
|
|
|
|
## Agent Skill
|
|
|
|
This repo includes an [Anthropic Agent Skill](https://github.com/anthropics/skills) that teaches AI assistants how to use ATXP tools.
|
|
|
|
### Installation
|
|
|
|
Copy the skill to your Claude skills directory:
|
|
```bash
|
|
cp -r skills/atxp ~/.claude/skills/
|
|
```
|
|
|
|
Or install via skills.sh:
|
|
```bash
|
|
npx skills add atxp-dev/cli
|
|
```
|
|
|
|
### What It Enables
|
|
|
|
Once installed, Claude can use ATXP tools when you ask for:
|
|
- Web search (`npx atxp search <query>`)
|
|
- AI image generation (`npx atxp image <prompt>`)
|
|
- AI music generation (`npx atxp music <prompt>`)
|
|
- AI video generation (`npx atxp video <prompt>`)
|
|
- X/Twitter search (`npx atxp x <query>`)
|
|
|
|
## Development
|
|
|
|
Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
Build all packages:
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
Test the CLI locally:
|
|
```bash
|
|
cd packages/atxp
|
|
npm run dev
|
|
```
|
|
|
|
## Publishing
|
|
|
|
Each package is published independently:
|
|
|
|
```bash
|
|
cd packages/atxp
|
|
npm publish
|
|
|
|
cd ../create-atxp
|
|
npm publish
|
|
```
|
|
|
|
## License
|
|
|
|
MIT |