{"id":20058675,"url":"https://github.com/roboflow/roboflow-cli","last_synced_at":"2025-05-05T14:31:32.246Z","repository":{"id":63252991,"uuid":"565996350","full_name":"roboflow/roboflow-cli","owner":"roboflow","description":"Command Line Interface for Roboflow","archived":false,"fork":false,"pushed_at":"2024-12-10T15:22:47.000Z","size":1019,"stargazers_count":7,"open_issues_count":7,"forks_count":3,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-04T23:52:19.155Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roboflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-14T19:00:43.000Z","updated_at":"2025-03-04T17:42:52.000Z","dependencies_parsed_at":"2024-11-13T13:03:20.131Z","dependency_job_id":"d8f9f412-36df-464c-8cda-cbcc647c8147","html_url":"https://github.com/roboflow/roboflow-cli","commit_stats":null,"previous_names":["roboflow-ai/roboflow-cli"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roboflow","download_url":"https://codeload.github.com/roboflow/roboflow-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252514993,"owners_count":21760484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T13:03:10.804Z","updated_at":"2025-05-05T14:31:31.721Z","avatar_url":"https://github.com/roboflow.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Roboflow banner](https://user-images.githubusercontent.com/60797147/240767170-1793a92b-4ef7-469e-ae43-2a188ea9d2d3.jpeg)\n\n# Roboflow CLI 💻\n\nThe Roboflow CLI provides a command line-driven method through which you can interface with Roboflow, upload data, and run inference on images.\n\n## Installation 🛠️\n\nThis package install a `roboflow` CLI you can use from your terminal.\n\nTo install the Roboflow CLI, use the following command:\n\n```\nnpm i -g roboflow-cli\n```\n\n\u003cdetails close\u003e\n\u003csummary\u003e👉 Run the CLI in a docker container (alpha support)\u003c/summary\u003e\n\n### Run the CLI in a docker container (alpha support)\n\nIf you don't want to install node, npm and other roboflow cli dependencies, but still use the roboflow cli you can run it in a docker container.\n\nAssuming you have docker installed on your machine, first build the image\n\n```\ndocker build -t roboflowcli:latest .\n```\n\nThen, run the Roboflow cli docker image:\n\n```\n# Authorize \n\ndocker run -it --rm -v ~/.config/roboflow:/root/.config/roboflow roboflowcli:latest auth\n\n# Use the CLI as usual inside a docker container.\n\ndocker run -it --rm -v ~/.config/roboflow:/root/.config/roboflow roboflowcli:latest project list\n```\n\nHere we have mounted the roboflow credentials into the docker container. The first docker command authorizes the user and stores credentials \nin the user's `$HOME/.config/roboflow` directory. These credentials are then mounted onto the docker container in subsequent runs, as shown above.\n\u003c/details\u003e\n\n## Authenticate with the CLI\n\nTo authorize your CLI, run the following command.\n\n```\nroboflow login\n```\n\nThis will open a browser window and have you log into roboflow where you can select any workspaces you want the CLI to store auth credentials for (The CLi will download the api keys for the workspaces and store them in a config fle in the `~/.config/roboflow` directory on your system).\n\n## Quickstart 🚀\n\nYou can use the `roboflow` CLI to:\n\n-   list your workspaces\n-   select a default workspace to use\n-   list your projects\n-   upload images to your projects\n-   use it to get inference results for local images (for any of your object detection, classification, or segmentation models)\n\nFor more info on how to use the CLI see the help an usage instructions by running:\n\n```\nroboflow -h\n```\n\nYou can also get specific help for each of the available subcommands, like e.g.:\n\n```\nroboflow upload -h\n```\n\nor\n\n```\nroboflow detect -h\n```\n\nYou will similarly have to mount any data directories in case you are uploading images or annotations, for example.\n\n## Documentation 📚\n\nTo view a full reference for the RoboflowAPI and CLI, check out the [Roboflow API Reference](https://docs.roboflow.com/api-reference/install-cli).\n\n## License 🧑‍⚖\n\nThis project is licensed under an [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froboflow%2Froboflow-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froboflow%2Froboflow-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froboflow%2Froboflow-cli/lists"}