fractal project¶

usage: fractal project [-h] {new,list,show,delete,add-dataset,edit} ...

Project commands.

options:
  -h, --help            show this help message and exit

Valid sub-commands:
  {new,list,show,delete,add-dataset,edit}

usage: fractal project new [-h] name

Create new project.

positional arguments:
  name        Name of new project.

options:
  -h, --help  show this help message and exit

usage: fractal project list [-h]

List projects.

options:
  -h, --help  show this help message and exit

usage: fractal project show [-h] project_id

Show details of single project.

positional arguments:
  project_id  ID of project to show.

options:
  -h, --help  show this help message and exit

usage: fractal project delete [-h] project_id

Delete project.

positional arguments:
  project_id  ID of project to delete.

options:
  -h, --help  show this help message and exit

usage: fractal project add-dataset [-h] [--project-dir PROJECT_DIR]
                                   [--zarr-subfolder ZARR_SUBFOLDER]
                                   project_id dataset_name

Add dataset to project.

positional arguments:
  project_id            ID of project to add the new dataset to.
  dataset_name          Name of new dataset.

options:
  -h, --help            show this help message and exit
  --project-dir PROJECT_DIR
                        Choose which project directory your dataset zarr
                        directory is placed in. To add additional project
                        directory choices, contact an admin.
  --zarr-subfolder ZARR_SUBFOLDER
                        Specify where in your project directory the dataset
                        zarr directory should be. This is a path relative to
                        the project directory and needs to stay within the
                        chosen project directory. By default, Fractal will
                        create a folder for the project with a subfolder for
                        the dataset.

usage: fractal project edit [-h] [--new-name NEW_NAME] project_id

Edit details of a single project.

positional arguments:
  project_id           ID of the project to edit.

options:
  -h, --help           show this help message and exit
  --new-name NEW_NAME  New project name.