-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Slightly enhance command line interface feature.
Added README.md, run tests using travis, run CLI tests from VS code.
- Loading branch information
Nikita Manovich
committed
Sep 30, 2019
1 parent
db19cbf
commit 5b5329d
Showing
4 changed files
with
48 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Command line interface (CLI) | ||
**Description** | ||
A simple command line interface for working with CVAT tasks. At the moment it | ||
implements a basic feature set but may serve as the starting point for a more | ||
comprehensive CVAT administration tool in the future. | ||
|
||
Overview of functionality: | ||
|
||
- Create a new task (supports name, bug tracker, labels JSON, local/share/remote files) | ||
- Delete tasks (supports deleting a list of task IDs) | ||
- List all tasks (supports basic CSV or JSON output) | ||
- Download JPEG frames (supports a list of frame IDs) | ||
- Dump annotations (supports all formats via format string) | ||
|
||
**Usage** | ||
```bash | ||
usage: cli.py [-h] [--auth USER:[PASS]] [--server-host SERVER_HOST] | ||
[--server-port SERVER_PORT] [--debug] | ||
{create,delete,ls,frames,dump} ... | ||
|
||
Perform common operations related to CVAT tasks. | ||
|
||
positional arguments: | ||
{create,delete,ls,frames,dump} | ||
|
||
optional arguments: | ||
-h, --help show this help message and exit | ||
--auth USER:[PASS] defaults to the current user and supports the PASS | ||
environment variable or password prompt. | ||
--server-host SERVER_HOST | ||
host (default: localhost) | ||
--server-port SERVER_PORT | ||
port (default: 8080) | ||
--debug show debug output | ||
``` | ||
**Examples** | ||
- List all tasks | ||
`cli.py --auth user:pass --server-host localhost --server-port 8080 ls` | ||
- Create a task | ||
`cli.py create --name "new task" --labels labels.json local file1.jpg file2.jpg` | ||
- Delete some tasks | ||
`cli.py delete 100 101 102` | ||
- Dump annotations | ||
`cli.py dump --format "CVAT XML 1.1 for images" 103 output.xml` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters