CLI Reference¶

usage: fractal [-h] [-u USER] [-p PASSWORD] [--token-path TOKEN_PATH]
               [--fractal-server FRACTAL_SERVER] [--debug] [--batch]
               {project,dataset,task,workflow,job,version,user,group,resource,profile,template}
               ...

Command-line interface for Fractal Client.

options:
  -h, --help            show this help message and exit
  -u USER, --user USER  User email address for login (overrides `FRACTAL_USER`
                        environment variable).
  -p PASSWORD, --password PASSWORD
                        User password (overrides `FRACTAL_PASSWORD`
                        environment variable).
  --token-path TOKEN_PATH
                        User token (overrides `FRACTAL_TOKEN_PATH` environment
                        variable).
  --fractal-server FRACTAL_SERVER
                        URL of Fractal server (overrides `FRACTAL_SERVER`
                        environment variable).
  --debug               Change minimal logging level from INFO to DEBUG.
  --batch               Return output suitable for scripting, e.g., only the
                        ID of items created instead of the full object.

Commands:
  {project,dataset,task,workflow,job,version,user,group,resource,profile,template}