Retool CLI

1.0.29 verified Sat Apr 25 auth: no javascript

Command line interface for Retool, a low-code platform for building internal tools. Current stable version is 1.0.29. This CLI enables developers to create, manage, and deploy Retool apps from the terminal, including signup, login, and project scaffolding. It is the primary interface for programmatic interaction with Retool outside of the web UI. Differentiators include tight integration with Retool's platform, support for custom commands via a plugin-like architecture, and a focus on developer experience with TypeScript types. Release cadence is irregular as it's maintained by Retool, with updates typically aligned with platform changes.

Common errors

error EACCES: permission denied, access '/usr/local/lib/node_modules' ↓

cause Trying to install the package globally without sufficient permissions.

fix

Use a version manager like nvm or configure npm prefix: npm config set prefix '~/.npm-global'

error retool: command not found ↓

cause The package is not installed globally or not in PATH.

fix

Run 'npm install -g retool-cli' again or use 'npx retool' instead.

Warnings

gotcha Global install with npm may require sudo on Unix systems, causing EACCES permissions errors. ↓

fix Configure npm prefix or use npx instead of global install.

deprecated The `retool signup` command may be deprecated in favor of web-based signup in future versions. ↓

fix Use the Retool web UI at https://retool.com to create an account.

breaking Node.js versions below 12 are not supported and will cause runtime errors. ↓

fix Upgrade Node.js to v12 or later (recommended: v16+).

gotcha Commands are defined in `src/commands/` directory; adding a file there auto-registers it, which may accidentally expose internal utilities. ↓

fix Only place command modules in `src/commands/`; place utilities in `src/utils/`.

Install

npm install retool-cli

yarn add retool-cli

pnpm add retool-cli

Imports

default
wrong
```
const cli = require('retool-cli')
```
correct
```
import cli from 'retool-cli'
```
The package is primarily consumed as a CLI tool via global install, not as a library import. However, if used programmatically, it exports a default command module.
CommandModule
```
import { CommandModule } from 'retool-cli'
```
Type-only export used for extending or creating new commands. Since v1.0.0.
retool CLI command
wrong
```
retool-cli --help
```
correct
```
npx retool --help
```
The binary is invoked as `retool`, not `retool-cli`.

Quickstart

Installs the CLI globally, signs up for a Retool account, logs in, and creates a new app from a blank template.

npm install -g retool-cli
retool signup
retool login
retool create my-app --template blank