ygg-cli 0.1.0

YGG Command Line Interface

YGG CLI

Command line interface for the YGG platform.

Installation

cd cli
pip install -e .

Or install directly:

pip install -e /path/to/ygg/cli

Configuration

The CLI requires the YGG_API_KEY environment variable to be set. The API key must have *:*:admin:* permissions.

export YGG_API_KEY="ygg_api_..."

Optionally, set the base URL:

export YGG_BASE_URL="https://api.ygg.com"  # Default: http://localhost:9000

Usage

Environment Management

Export environment as .env format:

ygg env <project_id> <env>

Example:

ygg env proj_123 dev
# Outputs:
# DATABASE_URL=postgres://...
# API_KEY=secret123

Import environment from stdin:

cat .env | ygg env <project_id> <env>

Example:

cat .env | ygg env proj_123 prod

Database Schema Export

Export database schema in B3 format:

ygg db <project_id> <env>

Example:

ygg db proj_123 dev
# Outputs B3 schema format (see get_schema_compact.py for format details)

API Endpoints

The CLI expects the following endpoints to be implemented in the Go server:

• GET /v1/cli/projects/{project_id}/envs/{env}/export - Export environment as .env format (text/plain)
• POST /v1/cli/projects/{project_id}/envs/{env}/import - Import environment from .env format (text/plain)
• GET /v1/cli/projects/{project_id}/db/{env}/schema - Export database schema in B3 format (text/plain)

If these endpoints are not available, the CLI will fall back to:

• GET /v1/projects/{project_id}/envs/{env} - Get environment (converted to .env format client-side)
• PATCH /v1/projects/{project_id}/envs/{env} - Update environment (parsed from .env format client-side)

Requirements

• Python 3.7+
• requests library

Notes

• All computations should be done in the Go server. The Python CLI is a thin client that makes HTTP requests.
• The API key must have *:*:admin:* permissions to work.
• The key only works for a specific account.