Command Line Interface¶
The Quesadiya command-line interface (CLI) is used to manage your projects.
With the Quesadiya CIL, you can run, create, delete, inspect, modify
your data annotation projects and export annotated data sets . To list
available commands, either run quesadiya or quesadiya --help.
$ quesadiya --help
Usage: quesadiya [OPTIONS] COMMAND [ARGS]...
A delicious mexican dish.
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
create Create a data annotation project.
delete Delete project indicated by project name.
export Export data associated with a project indicated by project name.
inspect Show project information indicated by project name.
modify Modify a project indicated by project name.
path Print path to this package.
run Run annotation project.
quesadiya¶
A delicious mexican dish.
quesadiya [OPTIONS] COMMAND [ARGS]...
Options
-
--version¶ Show the version and exit.
create¶
Create a data annotation project.
quesadiya create [OPTIONS] PROJECT ADMIN DATAPATH
Options
-
-d,--project-description<project_description>¶ Description of a project to create.
-
-c,--contact<contact>¶ Contact to admin user.
-
-a,--add-collaborators<add_collaborators>¶ Add collaboratos from a jsonl file. Each row in the file must follow the following format: {'name': str, 'password': str, 'contact': str}. Note that contact field can be empty.
Arguments
-
PROJECT¶ Required argument
-
ADMIN¶ Required argument
-
DATAPATH¶ Required argument
delete¶
Delete project indicated by project name. Note that this operation will delete all data associated with a project.
quesadiya delete [OPTIONS] PROJECT
Arguments
-
PROJECT¶ Required argument
export¶
Export data associated with a project indicated by project name.
quesadiya export [OPTIONS] PROJECT OUTPUT_PATH
Options
-
-i,--include-text¶ Include text field assocaited with sample ids into output file.
Arguments
-
PROJECT¶ Required argument
-
OUTPUT_PATH¶ Required argument
inspect¶
Show project information indicated by project name.
quesadiya inspect [OPTIONS] PROJECT
Options
-
-s,--show-collaborators¶ Show all collaborators associated with a project. This operation requires admin authentication.
Arguments
-
PROJECT¶ Required argument
modify¶
Modify a project indicated by project name. Note that it exectues one operation per run.
quesadiya modify [OPTIONS] PROJECT
Options
-
-e,--edit<edit>¶ Edit admin contact or project description of a project.
Options: contact|description
-
-t,--transfer-ownership¶ Change admin name and admin password of a project.
-
-a,--add-collaborators<add_collaborators>¶ Add collaboratos from a jsonl file. Each row in the file must follow the following format: {'name': str, 'password': str, 'contact': str}. Note that contact field can be empty.
Arguments
-
PROJECT¶ Required argument