{"id":18754,"library":"retool-cli","title":"Retool CLI","description":"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.","status":"active","version":"1.0.29","language":"javascript","source_language":"en","source_url":"https://github.com/tryretool/retool-cli","tags":["javascript","typescript"],"install":[{"cmd":"npm install retool-cli","lang":"bash","label":"npm"},{"cmd":"yarn add retool-cli","lang":"bash","label":"yarn"},{"cmd":"pnpm add retool-cli","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"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.","wrong":"const cli = require('retool-cli')","symbol":"default","correct":"import cli from 'retool-cli'"},{"note":"Type-only export used for extending or creating new commands. Since v1.0.0.","symbol":"CommandModule","correct":"import { CommandModule } from 'retool-cli'"},{"note":"The binary is invoked as `retool`, not `retool-cli`.","wrong":"retool-cli --help","symbol":"retool CLI command","correct":"npx retool --help"}],"quickstart":{"code":"npm install -g retool-cli\nretool signup\nretool login\nretool create my-app --template blank","lang":"typescript","description":"Installs the CLI globally, signs up for a Retool account, logs in, and creates a new app from a blank template."},"warnings":[{"fix":"Configure npm prefix or use npx instead of global install.","message":"Global install with npm may require sudo on Unix systems, causing EACCES permissions errors.","severity":"gotcha","affected_versions":"*"},{"fix":"Use the Retool web UI at https://retool.com to create an account.","message":"The `retool signup` command may be deprecated in favor of web-based signup in future versions.","severity":"deprecated","affected_versions":"<=1.0.29"},{"fix":"Upgrade Node.js to v12 or later (recommended: v16+).","message":"Node.js versions below 12 are not supported and will cause runtime errors.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Only place command modules in `src/commands/`; place utilities in `src/utils/`.","message":"Commands are defined in `src/commands/` directory; adding a file there auto-registers it, which may accidentally expose internal utilities.","severity":"gotcha","affected_versions":"*"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Use a version manager like nvm or configure npm prefix: npm config set prefix '~/.npm-global'","cause":"Trying to install the package globally without sufficient permissions.","error":"EACCES: permission denied, access '/usr/local/lib/node_modules'"},{"fix":"Run 'npm install -g retool-cli' again or use 'npx retool' instead.","cause":"The package is not installed globally or not in PATH.","error":"retool: command not found"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}