From b8d5abe78e48a03f51f92f9c4a7de6b99cd291a7 Mon Sep 17 00:00:00 2001 From: Emilio Amaya Date: Mon, 26 Jan 2026 11:38:22 -0500 Subject: [PATCH] Update README with new tool commands - Add login command documentation - Add tool commands (search, image, music, video, x) - Update demo/create to use dev subcommand - Reorganize structure to match new CLI Co-Authored-By: Claude Opus 4.5 --- packages/atxp/README.md | 117 ++++++++++++++++++++++++++++------------ 1 file changed, 82 insertions(+), 35 deletions(-) diff --git a/packages/atxp/README.md b/packages/atxp/README.md index 1e66b9e..ab0c6de 100644 --- a/packages/atxp/README.md +++ b/packages/atxp/README.md @@ -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 @@ -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 ` +Search the web using ATXP. + +```bash +npx atxp search "latest AI news" +npx atxp search "weather in San Francisco" +``` + +#### `npx atxp image ` +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 ` +Generate music from a text prompt. + +```bash +npx atxp music "relaxing piano" +npx atxp music "upbeat electronic dance" +``` + +#### `npx atxp video ` +Generate a video from a text prompt. + +```bash +npx atxp video "ocean waves crashing" +npx atxp video "timelapse of clouds" +``` + +#### `npx atxp x ` +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:** @@ -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 [options]` +#### `npx atxp dev create [options]` Creates a new ATXP project with the specified name. **Options:** @@ -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 @@ -94,4 +141,4 @@ ATXP is a platform for building web agents with OAuth and payment capabilities. ## License -MIT \ No newline at end of file +MIT