@scheduler-systems/gal-cli 0.1.12 → 0.1.13-beta.1

package/README.md

@@ -1,219 +1,41 @@
 # GAL CLI
 
-Command-line tool for managing AI agent configurations across your organization.
+Command-line tool for syncing AI agent configurations.
 
-**PROPRIETARY SOFTWARE** - Internal use only.
-
-## Installation
+## Development Install
 
 ```bash
-# Configure npm to use GitHub Packages for @scheduler-systems scope
-npm config set @scheduler-systems:registry https://npm.pkg.github.com
-
-# Authenticate with GitHub Packages (use your GitHub token)
-npm login --registry=https://npm.pkg.github.com
-
-# Install the CLI
-npm install -g @scheduler-systems/gal-cli
-```
-
-## Quick Start
-
-```bash
-# Configure your GAL API endpoint
-gal config set apiUrl https://api.gal.dev
-gal config set defaultOrg your-org-name
-
-# Fetch agent configurations
-gal fetch
-
-# Scan a repository
-gal scan owner/repo
-```
-
-## Commands
-
-### `gal fetch [orgName]`
-
-Download agent configurations from GAL API.
-
-```bash
-gal fetch                      # Fetch for default org
-gal fetch my-org               # Fetch for specific org
-gal fetch --platform claude    # Filter by platform
-gal fetch --json               # Output as JSON
-gal fetch --dry-run            # Preview without writing
-gal fetch list                 # List available organizations
-```
-
-### `gal config`
-
-Manage CLI configuration.
-
-```bash
-gal config set apiUrl https://api.gal.dev
-gal config set defaultOrg my-org
-gal config show
-gal config reset
-```
-
-### `gal sync`
-
-Sync local configurations to governance repository.
-
-```bash
-gal sync              # Sync all local configs
-gal sync --dry-run    # Preview changes
-```
-
-### `gal run <command>`
-
-Execute slash commands headlessly (for CI/CD).
-
-```bash
-gal run --list                    # List available commands
-gal run my-command "arguments"    # Run a command
-gal run my-command --dry-run      # Preview without executing
-gal run my-command --json         # Get JSON output
-gal run --file ./cmd.md "args"    # Run from file path
-```
-
-### `gal sandbox`
-
-E2B sandbox operations for safe testing.
-
-```bash
-gal sandbox start                           # Start sandbox session
-gal sandbox exec "echo hello"               # Execute code
-gal sandbox validate ./path/to/config.json  # Validate config
-```
-
-### `gal scan <repo>`
-
-Scan a GitHub repository for AI agent configurations.
-
-### `gal analyze`
-
-Analyze configurations for security issues.
-
-## Environments
-
-The CLI supports multiple environments via npm tags and API configuration:
-
-| Environment | npm Tag | Default API | Install Command |
-|-------------|---------|-------------|-----------------|
-| **Production** | `latest` | `https://api.gal.run` | `npm install -g @scheduler-systems-ai/gal-cli` |
-| **Staging** | `beta` | `https://api.gal.run` | `npm install -g @scheduler-systems-ai/gal-cli@beta` |
-| **Development** | local | `http://localhost:3000` | `pnpm build && npm link` |
-
-### Using Staging Environment
-
-```bash
-# Option 1: Install beta CLI (recommended for testing)
-npm install -g @scheduler-systems-ai/gal-cli@beta
-
-# Option 2: Override API URL for any CLI version
-GAL_API_URL=https://gal-api-wug5dzqj2a-uc.a.run.app gal sync --pull
-
-# Option 3: Persistent configuration
-gal config set apiUrl https://gal-api-wug5dzqj2a-uc.a.run.app
-gal sync --pull
+cd apps/cli
+pnpm install
+pnpm build
+npm link
 ```
 
-### Staging URLs
-
-| Service | URL |
-|---------|-----|
-| API | `https://gal-api-wug5dzqj2a-uc.a.run.app` |
-| Dashboard | `https://gal-staging-dashboard.web.app` |
-| Website | `https://gal-staging.web.app` |
-
-## Environment Variables
-
+Verify:
 ```bash
-# API Configuration
-GAL_API_URL=https://api.gal.run    # Override default API URL
-
-# Required
-GITHUB_TOKEN=your_github_token
-
-# Optional - E2B Sandbox
-E2B_API_KEY=your_e2b_api_key
-
-# Optional - Session Analysis with LLM
-GAL_SESSION_ANALYSIS_ENABLED=true
-GAL_LLM_PROVIDER=anthropic          # or 'openai'
-ANTHROPIC_API_KEY=your_key          # for Anthropic
-OPENAI_API_KEY=your_key             # for OpenAI
-```
-
-## Supported Platforms
-
-- Claude Code (`.claude/`)
-- Cursor (`.cursor/`)
-- Google Gemini (`.gemini/`)
-- OpenAI Codex (`.codex/`)
-- Windsurf (`.windsurf/`)
-
-## CI/CD Integration
-
-```yaml
-- name: Install GAL CLI
-  run: npm install -g gal-cli
-
-- name: Fetch configs
-  run: gal fetch --json > configs.json
+gal --version
 ```
 
-## Session Analysis
-
-When enabled, the CLI tracks commands during your session and provides LLM-powered analysis at the end:
-- Command success/failure tracking
-- Error analysis and recommendations
-- Session insights
-
-## Development
-
+After changes, rebuild:
 ```bash
-# Clone the monorepo
-git clone https://github.com/Scheduler-Systems/gal.git
-cd gal/apps/cli
-
-# Install dependencies
-pnpm install
-
-# Build
 pnpm build
-
-# Development mode (watch)
-pnpm dev
-```
-
-### Local Testing
-
-```bash
-# Set your GAL monorepo path
-export GAL_ROOT="/path/to/gal"  # e.g., ~/projects/gal
-
-# Build and install globally (subshell keeps you in current directory)
-(cd "$GAL_ROOT/apps/cli" && pnpm build && npm install -g .)
-
-# Verify
-gal --version
 ```
 
-After making changes, rebuild and reinstall:
+## Production Install
 
 ```bash
-(cd "$GAL_ROOT/apps/cli" && pnpm build && npm install -g .)
+npm install -g @scheduler-systems/gal-cli
 ```
 
-To uninstall:
+## Quick Start
 
 ```bash
-npm uninstall -g @scheduler-systems-ai/gal-cli
+gal sync --pull    # Pull approved config from org
+gal sync --push    # Push local config to org
 ```
 
-## License
+## Documentation
 
-Proprietary - Copyright (c) 2025 Scheduler Systems. All rights reserved.
+- [CLI Commands](../../docs/features/gal/convenience/05-sync.md)
+- [Headless Execution](../../docs/guides/cli-headless-execution.md)
+- [Hook Integration](../../docs/features/gal/convenience/10-cli-hook.md)