Comment on page

Command Line Interface

Use the Roboflow CLI to manage and interact with projects.
The Roboflow command line interface (CLI) is a tool through which you can manage and interact with projects. You can retrieve information about projects and workspaces, upload images and annotations, and run inferences on images using a model hosted on Roboflow.
The CLI supports a more limited set of actions than the REST API and Python SDK. We recommend using the CLI to upload datasets to Roboflow if you want to do so natively from the command line.


For more details, examples, and information, take a look at the Roboflow CLI documentation. Here are links to the documentation for the most used Roboflow CLI commands:

Install the Roboflow CLI

You will need to install npm before you can install the Roboflow CLI.
To install the Roboflow CLI globally on your system, use the following npm command:
npm i -g roboflow-cli
After that you should have the Roboflow command available to you in your terminal of choice.
Roboflow CLI

Authenticating with the Roboflow CLI

Once you have the Roboflow CLI installed on your system, you will want to authorize it to access your workspaces. There is an auth flow built into Roboflow to do this, type:
roboflow auth
Authing the Roboflow CLI to access your workspaces
This will open a browser window (or you can copy the URL it prints into a browser if your terminal doesn’t support opening a browser).
You’ll sign in to Roboflow, if you are not already, and then a one-time auth token will be generated that you can paste into the CLI. If you have multiple workspaces, you can select exactly which ones you want to allow the CLI to access. When you paste the auth token into the CLI, you will get your API keys and some basic workspace information.

Getting Started

The Roboflow CLI has a variety of functionality which makes it useful for a variety of use cases. You can get project information using roboflow project get or run inference on a model using roboflow infer. See more details on our dedicated CLI docs.

See Also

Last modified 3mo ago