Skip to content

Commit

Permalink
Add documentation for project commands
Browse files Browse the repository at this point in the history
  • Loading branch information
SpecLad committed Dec 6, 2024
1 parent acac605 commit 3a39ea2
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
5 changes: 5 additions & 0 deletions cvat-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ comprehensive CVAT administration tool in the future.

Overview of functionality:

- Projects:
- Create a new project
- Delete projects
- List all projects

- Tasks:
- Create a new task
- Create a task from a backup file
Expand Down
37 changes: 37 additions & 0 deletions site/content/en/docs/api_sdk/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ comprehensive CVAT administration tool in the future.

Overview of functionality:

- Projects:
- Create a new project
- Delete projects
- List all projects

- Tasks:
- Create a new task
- Create a task from a backup file
Expand Down Expand Up @@ -275,3 +280,35 @@ if it isn't there already.
```bash
PYTHONPATH=path/to/my-project cvat-cli task auto-annotate 139 --function-module my_func
```

## Examples - projects

### Create

To create a project, you have to define its labels.
The `project create` command accepts labels in the same format as the `task create` command;
see that command's examples for more information.

- Create a project named "new project" on the default server "localhost:8080",
with labels from the file "labels.json":
```bash
cvat-cli project create "new project" --labels labels.json
```

### Delete

- Delete projects with id "100", "101", "102":
```bash
cvat-cli project delete 100 101 102
```

### List

- List all projects:
```bash
cvat-cli project ls
```
- Save list of all projects into file "list_of_projects.json":
```bash
cvat-cli project ls --json > list_of_projects.json
```

0 comments on commit 3a39ea2

Please sign in to comment.