Roboflow Docs
DashboardResourcesProducts
  • Product Documentation
  • Developer Reference
  • Changelog
  • Developer Tools
  • Authentication
    • Find Your Roboflow API Key
    • Scoped API Keys
    • Workspace and Project IDs
  • Command Line Interface (CLI)
    • Using the CLI
    • Install and Set Up the CLI
    • List Workspaces and Projects
    • Download a Dataset
    • Upload a Dataset
    • Run a Model on an Image
  • REST API
    • Using the REST API
    • Authenticate with the REST API
    • List Workspaces and Projects
  • Search Images in a Dataset
  • Create a Project
  • Get a Project and List Versions
  • Manage Project Folders
  • List Image Batches
  • Create and List Annotation Jobs
  • Manage Images
    • Upload an Image
    • Get Details About an Image
    • Delete an Image from a Dataset
    • Upload an Annotation
    • Search for an Image
    • List, Add, and Remove Image Tags
  • Versions
    • View a Version
  • Export Data
  • Annotation Insights
    • Annotation Insights (Legacy Endpoint)
  • Model Monitoring
    • Retrieve Statistics About Deployed Models in a Workspace
    • Attach Metadata to an Inference
  • Python SDK
    • Using the Python SDK
  • Authenticate with the Python SDK
  • List Workspaces
  • List Projects and Versions
  • Create a Project
  • Create a Dataset Version
  • Train a Model
  • Upload a Dataset
  • Search for an Image
  • iOS SDK
    • Using the iOS SDK
Powered by GitBook
On this page

Was this helpful?

  1. Command Line Interface (CLI)

Install and Set Up the CLI

You will need to have Python 3.8 or higher set up to use the Roboflow Python package.

So, after you have python installed on your system, run the following command to install the Roboflow Python package:

pip install roboflow

After installing you should now have the roboflow CLI installed. Go ahead and test it.

roboflow --help

Which should show some help about the roboflow commands that you can run

If that's working, then you need to authenticate so that you can run CLI commands as your roboflow user.

roboflow login

Open the link on your browser, get the token and paste it on the terminal and hit ENTER. The credentials are saved in the disk at ~/.config/roboflow/config.json so you should only need to do that once.

PreviousUsing the CLINextList Workspaces and Projects

Last updated 7 days ago

Was this helpful?