0.1.6 • Published 7 months ago

@ongoku/ongoku-cli v0.1.6

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

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 pull

Key Commands

CommandDescription
loginAuthenticate with Ongoku
cloneDownload project to local machine
pushUpload schema changes to Ongoku
pullFetch latest changes from Ongoku
projectDisplay current project details
list/lsList available projects

Configuration

The CLI can be configured using environment variables:

Environment VariableDescriptionDefault
ONGOKU_API_URLCustom API endpoint URLhttp://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 link

Commands for Development

  • npm run build: Build the TypeScript source
  • npm run watch: Watch for changes and rebuild
  • npm run test: Run tests
  • npm run dev: Run the CLI in development mode

License

MIT

0.1.6

7 months ago

0.1.5

7 months ago

0.1.4

7 months ago

0.1.2

7 months ago

0.1.0

7 months ago