0.1.6 • Published 7 months ago
@ongoku/ongoku-cli v0.1.6
Ongoku CLI
Command-line interface for Ongoku projects - manage schemas and synchronize changes between local development and the Ongoku platform.
Overview
Ongoku CLI enables developers to:
- Work with Ongoku project schemas locally
- Synchronize changes between local environment and Ongoku web app
- Manage Git operations for project files
Quick Start
# Install globally
npm install -g ongoku-cli
# Authenticate
ongoku login
# Clone project
ongoku clone project-name
# Make changes to project schema
cd project-name
# Edit files in goku_schema/app.schema.yml
# Push changes
ongoku push
# Pull latest changes
ongoku pullKey Commands
| Command | Description |
|---|---|
login | Authenticate with Ongoku |
clone | Download project to local machine |
push | Upload schema changes to Ongoku |
pull | Fetch latest changes from Ongoku |
project | Display current project details |
list/ls | List available projects |
Configuration
The CLI can be configured using environment variables:
| Environment Variable | Description | Default |
|---|---|---|
ONGOKU_API_URL | Custom API endpoint URL | http://ongoku.com/api/cli |
Development
For CLI development:
git clone https://github.com/build-ongoku/ongoku-cli.git
cd ongoku-cli
npm install
npm run build
npm linkCommands for Development
npm run build: Build the TypeScript sourcenpm run watch: Watch for changes and rebuildnpm run test: Run testsnpm run dev: Run the CLI in development mode
License
MIT