A simple command line interface for Retool. Run retool signup
to create a Retool account in 20 seconds.
Open an issue in this repository for feature requests. PRs welcome!
npm install -g retool-cli
Node.js is a requirement, it can be installed here. See this guide to resolve EACCES permissions errors.
retool --help
retool <command> --help
git clone https://github.com/tryretool/retool-cli.git
cd retool-cli
npm i && npm run dev
npm install -g .
Installs theretool
command globally on your machine.
- Locate the command file in
src/commands/
. - Add a new flag to the
builder
object and provide a clear description. This description will be displayed to the user in the help command. - Handle the new flag by adding an
else if (argv.newFlag)
statement to the handler function.
- Create a new file in the
src/commands
directory, ensure it exports aCommandModule
. npm run dev
to start TS compiler.retool login
to authenticate.retool commandName
to test command.
- Retool CLI adheres to the principles outlined in this CLI guide:
- Keep output succinct.
- In help output:
- Use
<>
to indicate required params and[]
for optional params. - Provide a usage example if appropriate.
- Use
- Errors should be presented in a human-readable format.
- Hide debug output behind a
process.env.DEBUG
check.
- Any files in
src/commands/
directory will become a top-level commands. - Shared logic should be placed in
src/utils/
directory.
- Bump version in
package.json
,npm install
, commit changes npm run build
npm publish