cli

💻 The Capawesome Cloud Command Line Interface (CLI) can be used to manage Live Updates from the command line.

Installation

The Capawesome Cloud CLI can be installed globally via npm:

npm install -g @capawesome/cli

Usage

The Capawesome Cloud CLI can be invoked with the @capawesome/cli command.

npx @capawesome/cli <command> [options]

You can find a list of available commands in the Command Reference.

Help

The Capawesome Cloud CLI ships with command documentation that is accessible with the --help flag.

npx @capawesome/cli --help

Telemetry

The Capawesome Cloud CLI sends crash reports to help us identify and fix bugs. No usage analytics are collected.

To opt out, set the following environment variable:

export CAPAWESOME_TELEMETRY_DISABLED=1

Learn more in the Telemetry documentation.

Development

Getting Started

Run the following commands to get started with development:

1. Clone the repository:

   git clone https://github.com/capawesome-team/cli.git
   

2. Install dependencies:

   npm install
   

3. Optional: copy .env.example to .env to point the CLI at another API, console or environment (CAPAWESOME_API_BASE_URL, CAPAWESOME_CONSOLE_BASE_URL, CAPAWESOME_ENVIRONMENT). npm start loads it (Node.js 20.19 or newer).

4. Run your first command:

   npm start -- --help
   

   Note: The -- is required to pass arguments to the script.

Testing Proxy Support

To test HTTP/HTTPS proxy functionality locally:

1. Start Squid proxy in a separate terminal:

   docker run --rm --name squid-proxy -p 3128:3128 -v $(pwd)/squid.conf:/etc/squid/squid.conf:ro sameersbn/squid:latest
   

2. Set proxy environment variables and run the CLI:

   export https_proxy=http://localhost:3128
   npm run build && node ./dist/index.js login
   

3. To see debug output:

   DEBUG=https-proxy-agent node ./dist/index.js login
   

Changelog

See CHANGELOG.

License

See LICENSE.