Skip to content

project

Project commands.

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

Sub-commands

project new

Create new project.

fractal project new [-h] name

Positional Arguments

  • name: Name of new project.

project list

List projects.

fractal project list [-h]

project show

Show details of single project.

fractal project show [-h] project_id

Positional Arguments

  • project_id: ID of project to show.

project delete

Delete project.

fractal project delete [-h] project_id

Positional Arguments

  • project_id: ID of project to delete.

project add-dataset

Add dataset to project.

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

Positional Arguments

  • project_id: ID of project to add the new dataset to.

  • dataset_name: Name of new dataset.

Named Arguments

  • --project-dir: Choose which project directory your dataset zarr directory is placed in. To add additional project directory choices, contact an admin.

  • --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.

project edit

Edit details of a single project.

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

Positional Arguments

  • project_id: ID of the project to edit.

Named Arguments

  • --new-name: New project name.