@devourapp/cli

Command-line interface for the DevOur platform generator. Manage projects, versions, and bundles from your terminal.

Installation

npm i -g @devourapp/cli

Or run directly with npx:

npx @devourapp/cli [command]

Quick Start

# Configure your API key
devour setup-key

# List your projects
devour ls

# Create a new project
devour create my-project

# Download a project
devour fetch <projectId>

Commands

Authentication

| Command | Description | |---------|-------------| | devour setup-key | Configure or update your DevOur API key | | devour logout | Remove your stored API key |

Projects

| Command | Description | |---------|-------------| | devour ls | List all projects in your account | | devour create [name...] | Create a new project from name, config file, or interactively | | devour fetch [projectId] | Download a project bundle | | devour setup [projectId] | Setup or update project settings | | devour sync | Pull project settings from server to local config file |

Version Management

| Command | Description | |---------|-------------| | devour version create [projectId] | Create a new version | | devour version delete [projectId] | Delete a version | | devour version reset [projectId] | Reset project to a specific version | | devour version bundle [projectId] | Create a downloadable bundle for a version |

Common Options

Most commands support these options:

• --config <path> — Path to configuration file (defaults to devour.json, devour.yml, or devour.yaml)
• -v, --version <version> — Specify a version (for version commands and fetch)

Sync Options

The sync command has additional options for controlling how settings are merged:

• --overwrite — Overwrite local with remote settings
• --new — Replace all local settings with remote ones
• --local — Keep local settings, fill missing from remote
• --json — Output as JSON format
• --yaml — Output as YAML format

Configuration

The CLI stores your API key locally using configstore. To get an API key:

1. Log in to your DevOur dashboard
2. Navigate to Settings → API Keys
3. Generate or copy your API key

Security

• API keys are stored locally in your system's config directory
• Never share your API key or commit it to version control
• Keys can be revoked from your DevOur dashboard at any time