CLI Interface Created.

Signed-off-by: anex45 <[email protected]>

Author: anex45

CLI-COMMANDS.md

@@ -8,22 +8,25 @@ $ roboflow --help
 ```
 
 ```
-usage: roboflow [-h] {login,download,upload,import,infer,project,workspace} ...
+usage: roboflow [-h] {login,download,upload,import,infer,project,workspace,upload-dataset,list-datasets,list-models} ...
 
 Welcome to the roboflow CLI: computer vision at your fingertips 🪄
 
 options:
   -h, --help            show this help message and exit
 
 subcommands:
-  {login,download,upload,import,infer,project,workspace}
+  {login,download,upload,import,infer,project,workspace,upload-dataset,list-datasets,list-models}
     login               Log in to Roboflow
     download            Download a dataset version from your workspace or Roboflow Universe.
     upload              Upload a single image to a dataset
     import              Import a dataset from a local folder
     infer               perform inference on an image
     project             project related commands. type 'roboflow project' to see detailed command help
     workspace           workspace related commands. type 'roboflow workspace' to see detailed command help
+    upload-dataset      Upload a dataset from a local folder to a Roboflow project
+    list-datasets       List all datasets in a workspace
+    list-models         List all models in a workspace
 ```
 
 ## Authentication

CLI-COMMANDS.md.new

@@ -0,0 +1,344 @@
+# The roboflow-python command line
+This has the same capabilities of the [roboflow node cli](https://www.npmjs.com/package/roboflow-cli) so that our users don't need to install two different tools.
+
+## See available commands
+
+```bash
+$ roboflow --help
+```
+
+```
+usage: roboflow [-h] {login,download,upload,import,infer,project,workspace,upload-dataset,list-datasets,list-models} ...
+
+Welcome to the roboflow CLI: computer vision at your fingertips 🪄
+
+options:
+  -h, --help            show this help message and exit
+
+subcommands:
+  {login,download,upload,import,infer,project,workspace,upload-dataset,list-datasets,list-models}
+    login               Log in to Roboflow
+    download            Download a dataset version from your workspace or Roboflow Universe.
+    upload              Upload a single image to a dataset
+    import              Import a dataset from a local folder
+    infer               perform inference on an image
+    project             project related commands. type 'roboflow project' to see detailed command help
+    workspace           workspace related commands. type 'roboflow workspace' to see detailed command help
+    upload-dataset      Upload a dataset from a local folder to a Roboflow project
+    list-datasets       List all datasets in a workspace
+    list-models         List all models in a workspace
+```
+
+## Authentication
+
+You need to authenticate first
+
+```bash
+$ roboflow login
+```
+
+```
+visit https://app.roboflow.com/auth-cli to get your authentication token.
+Paste the authentication token here:
+```
+Open that link on your browser, get the token, paste it on the terminal.
+The credentials get saved to `~/.config/roboflow/config.json`
+
+## Display help usage for other commands
+
+"How do I download stuff?"
+
+```bash
+$ roboflow download --help
+```
+```
+usage: roboflow download [-h] [-f FORMAT] [-l LOCATION] datasetUrl
+
+positional arguments:
+  datasetUrl   Dataset URL (e.g., `roboflow-100/cells-uyemf/2`)
+
+options:
+  -h, --help   show this help message and exit
+  -f FORMAT    Specify the format to download the version. Available options: [coco, yolov5pytorch, yolov7pytorch, my-yolov6, darknet,
+               voc, tfrecord, createml, clip, multiclass, coco-segmentation, yolo5-obb, png-mask-semantic, yolov8, yolov9]
+  -l LOCATION  Location to download the dataset
+```
+
+"How do I import a dataset into my workspace?"
+
+```bash
+$ roboflow import --help
+```
+
+```
+usage: roboflow import [-h] [-w WORKSPACE] [-p PROJECT] [-c CONCURRENCY] [-f FORMAT] folder
+
+positional arguments:
+  folder          filesystem path to a folder that contains your dataset
+
+options:
+  -h, --help      show this help message and exit
+  -w WORKSPACE    specify a workspace url or id (will use default workspace if not specified)
+  -p PROJECT      project will be created if it does not exist
+  -c CONCURRENCY  how many image uploads to perform concurrently (default: 10)
+  -n BATCH_NAME   name of batch to upload to within project
+```
+
+## Example: download dataset
+
+Download [Joseph's chess dataset](https://universe.roboflow.com/joseph-nelson/chess-pieces-new/dataset/25) from Roboflow Universe in VOC format:
+
+```bash
+$ roboflow download -f voc -l ~/tmp/chess joseph-nelson/chess-pieces-new/25
+```
+```
+loading Roboflow workspace...
+loading Roboflow project...
+Downloading Dataset Version Zip in /Users/tony/tmp/chess to voc:: 100%|██████████████████████████| 19178/19178 [00:01<00:00, 10424.62it/s]
+
+Extracting Dataset Version Zip to /Users/tony/tmp/chess in voc:: 100%|██████████████████████████████| 1391/1391 [00:00<00:00, 8992.30it/s]
+```
+```bash
+$ ls -lh ~/tmp/chess
+total 16
+-rw-r--r--@    1 tony  staff   1.8K Jan  5 10:32 README.dataset.txt
+-rw-r--r--@    1 tony  staff   562B Jan  5 10:32 README.roboflow.txt
+drwxr-xr-x@   60 tony  staff   1.9K Jan  5 10:32 test
+drwxr-xr-x@ 1214 tony  staff    38K Jan  5 10:32 train
+drwxr-xr-x@  118 tony  staff   3.7K Jan  5 10:32 valid
+```
+
+## Example: import a dataset
+
+Upload a dataset from a folder to a project in your workspace
+
+```bash
+roboflow import -w my-workspace -p my-chess ~/tmp/chess
+```
+
+```
+loading Roboflow workspace...
+loading Roboflow project...
+Uploading to existing project my-workspace/my-chess
+[UPLOADED] /home/jonny/tmp/chess/102_jpg.rf.205e2a0cb0fabbbf32b4a936e2d6f1e4.jpg (sFpTfnyLpLA8QcqPwdvf) / annotations = OK
+[UPLOADED] /home/jonny/tmp/chess/2_jpg.rf.c1a4ed4e0c3947743b22ede09f7e1212.jpg (wDA2yxnLJWY5YwYwO7dP) / annotations = OK
+[UPLOADED] /home/jonny/tmp/chess/221_jpg.rf.e841c9bbb31a135b8f6274643f522686.jpg (UCv7MeuvEqo7PYElatEn) / annotations = OK
+[UPLOADED] /home/jonny/tmp/chess/10_jpg.rf.841f3ccdfc4b93ee68566e602025c03f.jpg (HnkCpUcYzxStvQF49VQW) / annotations = OK
+[UPLOADED] /home/jonny/tmp/chess/130_jpg.rf.29f756d510d2e488eb5e12769c7707ff.jpg (WxrFIhfaJ9H1JvaXMgfF) / annotations = OK
+[UPLOADED] /home/jonny/tmp/chess/112_jpg.rf.1a6e7b87410fa3f787f10e82bd02b54e.jpg (7tWtAn573cKrefeg5pIO) / annotations = OK
+```
+
+## Example: list workspaces
+List the workspaces you have access to
+
+```bash
+$ roboflow workspace list
+```
+
+```
+tonyprivate
+  link: https://app.roboflow.com/tonyprivate
+  id: tonyprivate
+
+wolfodorpythontests
+  link: https://app.roboflow.com/wolfodorpythontests
+  id: wolfodorpythontests
+
+test minimize
+  link: https://app.roboflow.com/test-minimize
+  id: test-minimize
+```
+
+## Example: get workspace details
+
+```bash
+$ roboflow workspace get tonyprivate
+```
+
+```
+{
+  "workspace": {
+    "name": "tonyprivate",
+    "url": "tonyprivate",
+    "members": 4,
+    "projects": [
+      {
+        "id": "tonyprivate/annotation-upload",
+        "type": "object-detection",
+        "name": "annotation-upload",
+        "created": 1685199749.708,
+        "updated": 1695910515.48,
+        "images": 1,
+        (...)
+      }
+    ]
+  }
+}
+```
+
+## Example: list projects
+
+```bash
+roboflow project list -w tonyprivate
+```
+```
+annotation-upload
+  link: https://app.roboflow.com/tonyprivate/annotation-upload
+  id: tonyprivate/annotation-upload
+  type: object-detection
+  versions: 0
+  images: 1
+  classes: dict_keys(['0', 'Rabbits1', 'Rabbits2', 'minion1', 'minion0', '5075E'])
+
+hand-gestures
+  link: https://app.roboflow.com/tonyprivate/hand-gestures-fsph8
+  id: tonyprivate/hand-gestures-fsph8
+  type: object-detection
+  versions: 5
+  images: 387
+  classes: dict_keys(['zero', 'four', 'one', 'two', 'five', 'three', 'Guard'])
+```
+
+## Example: get project details
+
+```bash
+$ roboflow project get tonyprivate/hand-gestures-fsph8
+```
+
+```
+{
+  "project": {
+    "id": "tonyprivate/hand-gestures-fsph8",
+    "type": "object-detection",
+    "name": "hand-gestures-fsph8",
+    "created": 1685199749.708,
+    "updated": 1695910515.48,
+    "images": 387,
+    "splits": {
+      "train": 310,
+      "valid": 39,
+      "test": 38
+    },
+    "classes": {
+      "zero": 55,
+      "four": 55,
+      "one": 55,
+      "two": 55,
+      "five": 55,
+      "three": 55,
+      "Guard": 57
+    },
+    "colors": {
+      "zero": "#FF625A",
+      "four": "#FF625A",
+      "one": "#FF625A",
+      "two": "#FF625A",
+      "five": "#FF625A",
+      "three": "#FF625A",
+      "Guard": "#FF625A"
+    },
+    "annotation": "object-detection",
+    "public": false,
+    "versions": 5,
+    "unannotated": 0
+  }
+}
+```
+
+## Example: upload a dataset
+
+Upload a dataset from a folder to a new project in your workspace
+
+```bash
+$ roboflow upload-dataset -w my-workspace -p new-project -t object-detection ~/datasets/my-dataset
+```
+
+```
+loading Roboflow workspace...
+Created project my-workspace/new-project
+[UPLOADED] /home/user/datasets/my-dataset/image1.jpg (sFpTfnyLpLA8QcqPwdvf) / annotations = OK
+[UPLOADED] /home/user/datasets/my-dataset/image2.jpg (wDA2yxnLJWY5YwYwO7dP) / annotations = OK
+[UPLOADED] /home/user/datasets/my-dataset/image3.jpg (UCv7MeuvEqo7PYElatEn) / annotations = OK
+```
+
+## Example: list datasets
+
+List all datasets in your workspace
+
+```bash
+$ roboflow list-datasets -w my-workspace
+```
+
+```
+Datasets in workspace 'my-workspace':
+
+chess-pieces
+  ID: my-workspace/chess-pieces
+  Type: object-detection
+  Images: 1391
+  Versions: 3
+  Latest version: 3
+  Classes: ['bishop', 'king', 'knight', 'pawn', 'queen', 'rook']
+
+hand-gestures
+  ID: my-workspace/hand-gestures
+  Type: object-detection
+  Images: 387
+  Versions: 5
+  Latest version: 5
+  Classes: ['zero', 'four', 'one', 'two', 'five', 'three', 'Guard']
+```
+
+## Example: list models
+
+List all models in your workspace
+
+```bash
+$ roboflow list-models -w my-workspace
+```
+
+```
+Models in workspace 'my-workspace':
+
+chess-pieces
+  ID: my-workspace/chess-pieces
+  Type: object-detection
+  Model version 3:
+    Created: 1685199749.708
+    Type: object-detection
+    ID: my-workspace/chess-pieces/3
+
+hand-gestures
+  ID: my-workspace/hand-gestures
+  Type: object-detection
+  Model version 4:
+    Created: 1685199749.708
+    Type: object-detection
+    ID: my-workspace/hand-gestures/4
+  Model version 5:
+    Created: 1685199749.708
+    Type: object-detection
+    ID: my-workspace/hand-gestures/5
+```
+
+## Example: list models for a specific project
+
+```bash
+$ roboflow list-models -w my-workspace -p hand-gestures
+```
+
+```
+Models in workspace 'my-workspace':
+
+hand-gestures
+  ID: my-workspace/hand-gestures
+  Type: object-detection
+  Model version 4:
+    Created: 1685199749.708
+    Type: object-detection
+    ID: my-workspace/hand-gestures/4
+  Model version 5:
+    Created: 1685199749.708
+    Type: object-detection
+    ID: my-workspace/hand-gestures/5
+```

README.md

@@ -69,7 +69,14 @@ pip install "roboflow[desktop]"
   <summary>Command line tool</summary>
 
   By installing roboflow python package you can use some of its functionality in the command line (without having to write python code).
-  See [CLI-COMMANDS.md](CLI-COMMANDS.md)
+  See [CLI-COMMANDS.md](CLI-COMMANDS.md) for detailed usage instructions.
+  
+  The CLI provides commands for common tasks including:
+  - Uploading datasets
+  - Downloading datasets
+  - Listing projects and models
+  - Running inference
+  - Managing workspaces
 </details>
 
 

roboflow/cli/__init__.py

@@ -0,0 +1 @@
+# CLI module for Roboflow Python SDK