Skip to content

README.md

Latest commit

 

History

History
88 lines (57 loc) · 2.05 KB

README.md

File metadata and controls

88 lines (57 loc) · 2.05 KB

cli

npm version npm downloads license

💻 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

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. Copy the .capawesomerc.example file to .capawesomerc

  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.