@fleekxyz/cli

Fleek CLI

Fleek CLI provides a unified command line interface to Fleek Services.

Details

Stack

• NodeJS as runtime environment.
• Commander.js as CLI creation tool.
• ESLint with Prettier for linting.
• Esbuild for files bundling.

Basic commands

The Fleek CLI command has the following structure:

$ fleek <service> <command> [options and parameters]

To view all available services and commands use:

$ fleek help

To see all available commands for a service, use the help documentation as any one of the followings:

$ fleek <service> help
$ fleek <service> <command> help

To get the version of the Fleek CLI:

$ fleek --version

Development

1. Install NodeJS from the official website or using nvm.
2. Install pnpm dependency manager.
3. Install dependencies usign pnpm i from rootpath.
4. Prepare your changes.
5. CLI_COMMAND="<command> <subcommand> [options and parameters]" pnpm dev, and happy testing!

Contributing

1. Fork it
2. Create your feature branch: git checkout -b my-new-feature
3. Run the tests: pnpm test
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Create new Pull Request following the corresponding template guidelines