Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 82 additions & 35 deletions packages/atxp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ATXP CLI

Command line tool for creating ATXP projects and running demos.
Command line tool for ATXP tools and development.

## Installation

Expand All @@ -15,22 +15,81 @@ npm install -g atxp
## Quick Start

```bash
# Show help and available commands
npx atxp
# Log in to ATXP
npx atxp login

# Search the web
npx atxp search "latest AI news"

# Run the interactive demo
npx atxp demo
# Generate an image
npx atxp image "sunset over mountains"

# Create a new project (requires app name)
npx atxp create my-app
# Search X/Twitter
npx atxp x "trending topics"
```

## Commands

### `npx atxp`
Shows help information and available commands.
### Authentication

#### `npx atxp login [options]`
Log in to ATXP by saving your connection string.

Get your connection string from: https://accounts.atxp.ai

**Options:**
- `--force` - Update connection string even if already set

After login, source the config to use in your terminal:
```bash
source ~/.atxp/config
```

### Tools

#### `npx atxp search <query>`
Search the web using ATXP.

```bash
npx atxp search "latest AI news"
npx atxp search "weather in San Francisco"
```

#### `npx atxp image <prompt>`
Generate an image from a text prompt.

```bash
npx atxp image "sunset over mountains"
npx atxp image "a cute robot playing guitar"
```

#### `npx atxp music <prompt>`
Generate music from a text prompt.

```bash
npx atxp music "relaxing piano"
npx atxp music "upbeat electronic dance"
```

#### `npx atxp video <prompt>`
Generate a video from a text prompt.

```bash
npx atxp video "ocean waves crashing"
npx atxp video "timelapse of clouds"
```

#### `npx atxp x <query>`
Search X/Twitter for live content.

### `npx atxp demo [options]`
```bash
npx atxp x "trending topics"
npx atxp x "AI announcements"
```

### Development

#### `npx atxp dev demo [options]`
Runs the interactive ATXP demo application.

**Options:**
Expand All @@ -41,15 +100,12 @@ Runs the interactive ATXP demo application.

**Examples:**
```bash
npx atxp demo
npx atxp demo --verbose
npx atxp demo --port 3000
npx atxp demo --dir ./my-demo
npx atxp demo --port 3000 --dir ./my-demo --verbose
npx atxp demo --refresh
npx atxp dev demo
npx atxp dev demo --verbose
npx atxp dev demo --port 3000
```

### `npx atxp create <app-name> [options]`
#### `npx atxp dev create <app-name> [options]`
Creates a new ATXP project with the specified name.

**Options:**
Expand All @@ -59,32 +115,23 @@ Creates a new ATXP project with the specified name.

**Examples:**
```bash
# Basic usage (auto-detects git)
npx atxp create my-app

# With specific framework
npx atxp create my-app --framework express

# Skip git initialization
npx atxp create my-app --no-git

# Force git initialization
npx atxp create my-app --git

# Alternative using npm create
npm create atxp my-app
npx atxp dev create my-app
npx atxp dev create my-app --framework express
npx atxp dev create my-app --no-git
```

### `npx atxp help`
Displays help information (same as running `npx atxp`).
### Other

#### `npx atxp help`
Displays help information.

## About ATXP

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

- Access ATXP tools (search, image generation, music, video, X search)
- Explore ATXP features through interactive demos
- Bootstrap new projects with ATXP integration
- Set up development environments quickly

## Learn More

Expand All @@ -94,4 +141,4 @@ ATXP is a platform for building web agents with OAuth and payment capabilities.

## License

MIT
MIT