@dccxx/auggiegw 1.0.5 → 1.0.6

package/README.md

@@ -1,104 +1,238 @@
 # @dccxx/auggiegw
 
-A Node.js TypeScript package with CLI support.
+A CLI tool for managing Augment Gateway authentication, proxy configuration, and custom prompts. This tool simplifies the workflow of authenticating with Augment Gateway, fetching proxy configurations, and managing custom prompts for the Augment AI assistant.
+
+## Features
+
+- 🔐 **Authentication Management**: Login/logout with secure credential storage
+- 🌐 **Proxy Configuration**: Automatic proxy setup and authentication
+- 📝 **Custom Prompts**: Fetch and save custom prompts to `~/.augment/commands/`
+- 🔄 **Auggie Integration**: Seamlessly forward commands to the Auggie CLI
+- ⚡ **Command Execution**: Execute any command with automatic session setup
 
 ## Installation
 
-Install dependencies:
+```bash
+npm install -g @dccxx/auggiegw
+```
+
+or with Bun:
 
 ```bash
-bun install
+bun install -g @dccxx/auggiegw
 ```
 
-## Development
+## Quick Start
+
+1. **Login to Augment Gateway**:
+   ```bash
+   auggiegw login
+   ```
+   You'll be prompted for your username and password.
+
+2. **Fetch Configuration**:
+   ```bash
+   auggiegw fetch
+   ```
+   This fetches proxy configuration, authenticates, and downloads custom prompts.
+
+## Commands
 
-Build the project:
+### `auggiegw login [username] [password]`
 
+Login and store credentials securely.
+
+**Interactive Mode** (Recommended):
 ```bash
-bun run build
+auggiegw login
 ```
+You'll be prompted to enter your username and password. The password input is hidden for security.
 
-Run linter:
-
+**Direct Mode**:
 ```bash
-bun run lint
+auggiegw login myusername mypassword
 ```
 
-Clean build artifacts:
+**What it does**:
+- Authenticates with the Augment Gateway API
+- Stores credentials in `~/.auggiegw/auth.json`
+- Token is used for subsequent commands
+
+---
+
+### `auggiegw logout`
+
+Logout and remove stored credentials.
 
 ```bash
-bun run clean
+auggiegw logout
 ```
 
-## Usage
+**What it does**:
+- Deletes the authentication file (`~/.auggiegw/auth.json`)
+- Removes stored credentials from your system
 
-### Authentication
+---
 
-There are two ways to authenticate with auggiegw:
+### `auggiegw fetch`
 
-#### 1. Using Environment Variable (Recommended for CI/CD)
-
-Set the `AUGGIEGW_AUTH_TOKEN` environment variable with your authentication token:
+Fetch proxy configuration, authenticate, and download custom prompts.
 
 ```bash
-export AUGGIEGW_AUTH_TOKEN=your_token_here
+auggiegw fetch
+```
+
+**What it does**:
+1. Retrieves proxy configuration from Augment Gateway
+2. Authenticates the proxy
+3. Saves Augment session to `~/.augment/session.json`
+4. Fetches all custom prompts from the server
+5. Saves prompts as markdown files in `~/.augment/commands/`
+
+**Output Example**:
 ```
+✔ Successfully saved 15 prompts
+```
+
+---
 
-When this environment variable is set, the CLI will use it directly without requiring login or auth.json file.
+### `auggiegw auggie [args...]`
 
-#### 2. Using Login Command
+Forward commands to the Auggie CLI with automatic configuration.
 
-Login with your credentials:
+```bash
+auggiegw auggie [auggie-arguments]
+```
 
+**Examples**:
 ```bash
-auggiegw login [username] [password]
+# Run Auggie with help
+auggiegw auggie --help
 ```
 
-This will save your credentials to `~/.auggiegw/auth.json` for future use.
+**What it does**:
+1. Runs `auggiegw fetch` to ensure configuration is up-to-date
+2. Forwards all arguments to the `auggie` command
+3. Inherits stdio for interactive sessions
 
-### CLI Commands
+---
+
+### `auggiegw exec <command> [args...]`
+
+Execute any custom command with automatic session setup.
 
-#### Login
 ```bash
-auggiegw login [username] [password]
+auggiegw exec <command> [arguments]
 ```
 
-#### Logout
+**Examples**:
 ```bash
-auggiegw logout
+auggiegw exec auggie --help
 ```
 
-#### Fetch proxy configuration and prompts
+**What it does**:
+1. Runs `auggiegw fetch` to ensure configuration is up-to-date
+2. Executes the specified command with provided arguments
+3. Inherits stdio for interactive sessions
+
+---
+
+## Authentication Methods
+
+### Method 1: Login Command (Recommended for Local Development)
+
 ```bash
-auggiegw fetch
+auggiegw login
 ```
 
-#### Forward command to auggie CLI
+Credentials are stored in `~/.auggiegw/auth.json` and automatically used for subsequent commands.
+
+### Method 2: Environment Variable (Recommended for CI/CD)
+
+Set the `AUGGIEGW_AUTH_TOKEN` environment variable:
+
 ```bash
-auggiegw auggie [args...]
+export AUGGIEGW_AUTH_TOKEN=your_token_here
 ```
 
-#### Execute custom command
-```bash
-auggiegw exec <command> [args...]
+When this environment variable is set, the CLI uses it directly without requiring the login command or auth.json file.
+
+**Example in CI/CD**:
+```yaml
+# GitHub Actions example
+env:
+  AUGGIEGW_AUTH_TOKEN: ${{ secrets.AUGGIEGW_AUTH_TOKEN }}
 ```
 
-### As a library
+---
+
+## Configuration
 
-Import and use in your Node.js project:
+### File Locations
 
-```typescript
-import '@dccxx/auggiegw';
+- **Auth Data**: `~/.auggiegw/auth.json`
+- **Augment Session**: `~/.augment/session.json`
+- **Custom Prompts**: `~/.augment/commands/*.md`
+
+---
+
+## Custom Prompts
+
+Custom prompts are fetched from the Augment Gateway and saved as markdown files in `~/.augment/commands/`. Each prompt file follows this format:
+
+```markdown
+---
+description: Prompt Name
+---
+
+Prompt content goes here...
 ```
 
-## Project Structure
+The filename corresponds to the command name (e.g., `my-command.md`).
 
-- `src/` - TypeScript source files
-- `dist/` - Compiled JavaScript output (generated by build)
-- `tsconfig.json` - TypeScript configuration
-- `biome.json` - Biome linter configuration
+---
 
 ## Requirements
 
-- Node.js >= 18.0.0
-- Bun (for package management and running scripts)
+- **Node.js**: >= 18.0.0
+- **Bun**: For package management and running scripts (development)
+- **Auggie CLI**: Required for `auggiegw auggie` command
+
+---
+
+## Troubleshooting
+
+### "Not logged in" Error
+
+```
+Error: Not logged in. Please run "auggiegw login" first.
+```
+
+**Solution**: Run `auggiegw login` to authenticate.
+
+### "Failed to get proxy" Error
+
+**Possible causes**:
+- Invalid credentials
+- Network connectivity issues
+- API endpoint unavailable
+
+**Solution**: 
+1. Verify your credentials with `auggiegw logout` then `auggiegw login`
+2. Check your network connection
+3. Verify the API URL is correct
+
+### "No proxy data available" Error
+
+**Solution**: Contact your administrator to ensure your account has proxy access configured.
+
+---
+
+## License
+
+See LICENSE file for details.
+
+## Support
+
+For issues and questions, please open an issue on the GitHub repository.
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dccxx/auggiegw",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A Node.js TypeScript package",
   "main": "./dist/cli.js",
   "types": "./dist/cli.d.ts",