user

User commands.

fractal user [-h] {whoami,register,list,show,edit} ...

Sub-commands

user whoami

Get info on current user (fails if user is not registered).

fractal user whoami [-h] [--viewer-paths]

Named Arguments

• --viewer-paths: Include user's viewer_paths attribute. Default: False.

user register

Register a new user with the Fractal server and edit their settings (note: user creation and settings editing are two independent steps).

fractal user register [-h] [--cache-dir CACHE_DIR]  [--project-dir PROJECT_DIR]
        [--slurm-user SLURM_USER] [--username USERNAME]  [--ssh-settings-json
        SSH_SETTINGS_JSON]  [--superuser]  new_email new_password

Positional Arguments

• new_email: Email to be used as username.

• new_password: Password for the new user.

Named Arguments

• --cache-dir: User's cache directory absolute path (necessary for workflow execution when using the SLURM backend).

• --project-dir: User-writeable base folder, used e.g. for default zarr_dir paths.

• --slurm-user: Username to login into SLURM cluster.

• --username: Username associated to the user.

• --ssh-settings-json: Path to JSON file with (a subset of) following settings: ssh_host, ssh_username, ssh_private_key_path, ssh_tasks_dir, ssh_jobs_dir.

• --superuser: Give superuser privileges to the new user. Default: False.

user list

List all users.

fractal user list [-h]

user show

Show details of single user.

fractal user show [-h] user_id

Positional Arguments

• user_id: ID of the user.

user edit

Edit an existin user and/or their settings (note: user and settings editing are two independent steps).

fractal user edit [-h] [--new-email NEW_EMAIL]  [--new-password NEW_PASSWORD]
        [--new-username NEW_USERNAME]  [--new-cache-dir NEW_CACHE_DIR]
        [--new-project-dir NEW_PROJECT_DIR]  [--new-slurm-user NEW_SLURM_USER]
        [--new-ssh-settings-json NEW_SSH_SETTINGS_JSON]  [--make-superuser |
        --remove-superuser]  [--make-verified | --remove-verified]  user_id

Positional Arguments

• user_id: ID of the user.

Named Arguments

• --new-email: New email address.

• --new-password: New password.

• --new-username: New user username.

• --new-cache-dir: New user's cache directory absolute path (necessary for workflow execution when using the SLURM backend).

• --new-project-dir: New value of project_dir.

• --new-slurm-user: New SLURM username.

• --new-ssh-settings-json: Path to JSON file with (a subset of) following settings: ssh_host, ssh_username, ssh_private_key_path, ssh_tasks_dir, ssh_jobs_dir.

• --make-superuser: Give superuser privileges to user. Default: False.

• --remove-superuser: Remove superuser privileges from user. Default: False.

• --make-verified: Make user verified. Default: False.

• --remove-verified: Make user unverified. Default: False.