​
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

​
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

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

​
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