1.0.26 • Published 2 months ago
retool-cli v1.0.26
Retool CLI
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!
Installation & Updating
npm install -g retool-cli
Node.js is a requirement, it can be installed here. See this guide to resolve EACCES permissions errors.
Usage Instructions
retool --help
retool <command> --help
Building from Source
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.
Contribution Guide
Extending an existing command
- 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.
Adding a new command
- 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.
General guidelines
- 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.
1.0.26
2 months ago
1.0.25
4 months ago
1.0.22
7 months ago
1.0.21
7 months ago
1.0.23
7 months ago
1.0.20
8 months ago
1.0.19
9 months ago
1.0.18
9 months ago
1.0.17
9 months ago
1.0.16
9 months ago
1.0.15
9 months ago
1.0.14
10 months ago
1.0.13
10 months ago
1.0.12
10 months ago
1.0.11
10 months ago
1.0.10
10 months ago
1.0.9
10 months ago
1.0.8
10 months ago
1.0.7
10 months ago
1.0.6
10 months ago
1.0.5
10 months ago
1.0.4
10 months ago
1.0.3
11 months ago
1.0.2
11 months ago
1.0.1
11 months ago
1.0.0
11 months ago