retool-cli

library1.0.29jsnpmunverified

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.

devops web-framework

npm install retool-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · RETOOL-CLI

retool-cli

devopsjavascriptv1.0.29

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import cli from 'retool-cli'

✗ const cli = require('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

✓ npx retool --help

✗ retool-cli --help

The binary is invoked as `retool`, not `retool-cli`.

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

retool --version

Debug

Known issues

gotchaGlobal install with npm may require sudo on Unix systems, causing EACCES permissions errors.

fix

Configure npm prefix or use npx instead of global install.

affects: *

deprecatedThe `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.

affects: <=1.0.29

breakingNode.js versions below 12 are not supported and will cause runtime errors.

fix

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

affects: >=1.0.0

gotchaCommands 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/`.

affects: *

Errors

Common errors & fixes

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

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'

retool: command not found

The package is not installed globally or not in PATH.

fix

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

Upgrade

Version history

1.0.29latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

12 hits · last 30 days

node

Resources

githubhttps://github.com/tryretool/retool-cli ↗

packagehttps://www.npmjs.com/package/retool-cli ↗

homepagehttps://retool.com ↗