ToggLit CLI

A command-line interface for managing your configuration using ToggLit.

Premium Feature

CLI access is restricted to premium users. Free-tier users will need to upgrade to use CLI features.

Installation

You can run it directly with npx or install globally:

# Run directly with npx
npx togglit-cli login --api-key YOUR_API_KEY

# Install globally
npm install -g togglit-cli

yarn global add togglit-cli

pnpm add -g togglit-cli

Quick Start

togglit login --api-key YOUR_API_KEY
togglit init --project YOUR_PROJECT_ID --env production
togglit pull

Commands

`login`

Authenticate and store your API key for future CLI operations.

Parameters

Parameter	Type	Required	Description
--api-key	string	✅	Your Togglit API key
--global	flag	❌	Save credentials globally (default: project)

Examples

togglit login --api-key tk_live_xxxxxxx

togglit login --api-key tk_live_xxxxxxx --global

`init`

Initialize local project configuration and create a .togglit.json file.

Parameters

Parameter	Type	Required	Description
--project	string	✅	Your project identifier
--env	string	❌	Environment name (default: 'development')

Examples

Initialize with default development environment

togglit init --project togglit-demo

Initialize with specific environment

togglit init --project togglit-demo --env production

`pull`

Pull configuration from Togglit and save it locally.

Parameters

Parameter	Type	Required	Description
--project	string	❌	Your project identifier (uses config if not provided)
--env	string	❌	Environment name (uses config if not provided)
--config-version	number	❌	Specific configuration version to fetch
--output	string	❌	Output file path (default: 'config.json')

Examples

Pull latest configuration

togglit pull

Pull specific version

togglit pull --config-version 2

Pull to custom output file

togglit pull --output my-config.json

Pull with explicit project and environment

togglit pull --project my-project --env production

`rollback`

Rollback to a previous configuration version.

Parameters

Parameter	Type	Required	Description
--project	string	❌	Your project identifier (uses config if not provided)
--env	string	❌	Environment name (uses config if not provided)
--config-version	number	✅	Configuration version to rollback to

Examples

Rollback to version 2

togglit rollback --config-version 2

Rollback with explicit project and environment

togglit rollback --project my-project --env production --config-version 1

`diff`

Compare your local config with the latest remote version.

Parameters

Parameter	Type	Required	Description
--project	string	❌	Your project identifier (uses config if not provided)
--env	string	❌	Environment name (uses config if not provided)
--file	string	❌	Local config file to compare (default: 'config.json')

Examples

Compare with default config.json

togglit diff

Compare with custom file

togglit diff --file my-config.json

Compare with explicit project and environment

togglit diff --project my-project --env production

`generate-fallback`

Generate a fallback config file for offline usage.

Parameters

Parameter	Type	Required	Description
--project	string	❌	Your project identifier (uses config if not provided)
--env	string	❌	Environment name (uses config if not provided)

Examples

Generate fallback for current project

togglit generate-fallback

Generate fallback for specific project and environment

togglit generate-fallback --project my-project --env production

`versions`

List available config versions for your project.

Parameters

Parameter	Type	Required	Description
--project	string	❌	Your project identifier (uses config if not provided)
--env	string	❌	Environment name (uses config if not provided)

Examples

List versions for current project

togglit versions

List versions for specific project and environment

togglit versions --project my-project --env production

`status`

View current configuration and validation status.

Examples

View current status

togglit status

`logout`

Remove your stored credentials.

Parameters

Parameter	Type	Required	Description
--global	flag	❌	Remove global credentials (default: project)

Examples

Logout from project

togglit logout

Logout globally

togglit logout --global

Common Workflows

Basic Workflow

Login with your API key
Initialize your project
Pull the latest configuration
Check status

# 1. Login with your API key
togglit login --api-key tk_live_xxxxxxx

# 2. Initialize your project
togglit init --project my-app --env production

# 3. Pull the latest configuration
togglit pull

# 4. Check status
togglit status

Version Management

List available versions
Pull specific version
Compare current config with remote
Rollback to previous version

# List available versions
togglit versions

# Pull specific version
togglit pull --config-version 2

# Compare current config with remote
togglit diff

# Rollback to previous version
togglit rollback --config-version 1

Environment-Specific Operations

Development environment setup
Production environment setup

# Development environment
togglit init --project my-app --env development
togglit pull

# Production environment
togglit init --project my-app --env production
togglit pull --output prod-config.json

Configuration

The CLI uses the following priority order when resolving configuration:

CLI flags (--api-key, --project, --env, etc.)
Local config (.togglit.json in current directory)
Global config (~/.togglit/config.json)

The .togglit.json file stores your project configuration:

{
  "project": "your-project-id",
  "env": "production",
  "apiKey": "your-api-key"
}

Made with ❤️ By @gunaa_dev