FeatureOS CLI

A powerful command-line tool for managing your FeatureOS organization — boards, posts, comments, customers, changelogs, tags, teams, and roadmaps.

Installation

npm install -g @featureos/cli

Setup

Get your API Key and JWT Token from Settings → Developer → CLI Setup in your FeatureOS dashboard, then run:

featureos-cli init --api-key YOUR_API_KEY --jwt YOUR_JWT_TOKEN

This creates a config file at ~/.featureos.yaml.

Features

• Full CRUD — Manage all FeatureOS resources from the terminal
• Interactive TUI — Browse resources in a full-screen terminal UI (featureos-cli tui)
• Named Flags — Use --title, --name, --description, etc. for create/update
• JSON Payloads — Send raw JSON via --data or --file for advanced use cases
• Scripting Friendly — Use --json for raw JSON output suitable for piping

Quick Start

# Launch interactive TUI
featureos-cli tui

# List boards
featureos-cli boards list

# Create a post
featureos-cli posts create --title "Dark Mode" --board-id 42

# Create a changelog
featureos-cli changelogs create --title "v2.0 Release" --description "New features"

# Filter with query params
featureos-cli customers list --query "[email protected]"

# Raw JSON output for scripting
featureos-cli posts list --json

Command Reference

| Resource | Flags | Operations | |----------|-------|------------| | Boards | --name, --description | list, get, create, update, delete | | Posts | --title, --description, --status, --board-id | list, get, create, update | | Comments | --body, --post-id | list, create | | Customers | --name, --email | list, create | | Changelogs | --title, --description | list, create | | Roadmaps | --name, --description | list, create | | Tags | --name | list, create | | Teams | --name | list, create | | Organization | — | featureos-cli org |

Global Flags

| Flag | Description | |------|-------------| | --api-key | Override stored API key | | --jwt | Override stored JWT token | | --query "key=value" | Add query parameters | | --data '{...}' | Raw JSON payload (overrides named flags) | | --file path.json | JSON payload from file (overrides named flags) | | --json | Output raw JSON for scripting |

Supported Platforms

• macOS (Apple Silicon and Intel)
• Linux (ARM64 and x86_64)

Links

• FeatureOS Dashboard
• Documentation