Skip to main content

​
Prerequisites

Before installing ntcli, ensure you have the following prerequisites:

Node.js 20+

ntcli requires Node.js version 20 or higher

NPM or Yarn

Package manager for installing ntcli globally
Check your Node.js version with node --version. If you need to upgrade, visit nodejs.org or use a version manager like nvm.

​
Install ntcli

Install ntcli globally using NPM: 
npm install -g @nimbletools/ntcli

​
Yarn

Alternatively, install using Yarn: 
yarn global add @nimbletools/ntcli

​
Verify Installation

Verify that ntcli is installed correctly: 
ntcli --version
You should see the version number displayed. You can also run: 
ntcli --help
This will show all available commands and options.

​
Install from Source

For development or to use the latest unreleased features:
1

Clone the repository

bash git clone https://github.com/nimbletools/ntcli.git 
cd ntcli
2

Install dependencies

npm install
3

Build the project

npm run build
4

Link globally

npm link
5

Verify installation

ntcli --version

​
Environment Setup

​
Optional Configuration

Most environment variables are automatically configured. You may optionally customize these settings:
VariableDescriptionDefault
NTCLI_API_URLAPI base URLhttps://mcp.nimbletools.ai
NTCLI_DEFAULT_PORTOAuth callback server port41247

​
Platform-Specific Notes

  • macOS
  • Linux
  • Windows
Using Homebrew (Coming Soon)
# brew install
nimbletools/tap/ntcli
Using NPM
npm install -g @nimbletools/ntcli
Path IssuesIf ntcli command is not found, ensure /usr/local/bin (or your npm global bin directory) is in your PATH:
echo $PATH npm config get prefix

​
Updating ntcli

To update to the latest version: 
npm update -g @nimbletools/ntcli
Or reinstall: 
npm uninstall -g @nimbletools/ntcli
npm install -g @nimbletools/ntcli

​
Troubleshooting

​
Common Issues

Cause: ntcli is not in your system PATH.Solutions:
  1. Check if npm global bin directory is in PATH: npm config get prefix
  2. Add npm global bin to PATH: export PATH=$(npm config get prefix)/bin:$PATH
  3. Reinstall with sudo (not recommended): sudo npm install -g @nimbletools/ntcli
Cause: NPM trying to install to system directories without proper permissions.Solutions:
  1. Configure npm to use a user directory (recommended)
  2. Use a Node.js version manager like nvm
  3. Use sudo (not recommended for security reasons)
Cause: Multiple versions installed or cached.Solutions:
  1. Clear npm cache: npm cache clean --force
  2. Completely uninstall and reinstall
  3. Check installed location: which ntcli

​
Getting Help

If you encounter issues during installation:
  1. Check our troubleshooting guide: Troubleshooting
  2. Open an issue: GitHub Issues
  3. Join our community: Slack

​
Next Steps

Once ntcli is installed:

Quick Start

Get up and running with ntcli in under 5 minutes

Authentication

Learn how to authenticate with the NimbleTools platform
⌘I