Commands

Test Connection

Test connectivity to a Curiosity workspace.

curiosity-cli test -s <server-url> -t <token>

  • -s, --server: Workspace URL (required)

  • -t, --token: Authentication token (required)

  • --timeout: Request timeout in seconds (default: 90)

Upload Front-End

Deploy a compiled front-end application to a workspace.

curiosity-cli upload-front-end -s <server-url> -t <token> -p <path>

  • -s, --server: Workspace URL (required)

  • -t, --token: Authentication token (required)

  • -p, --path: Path to compiled front-end files

  • -a, --auto-patch: Enable automatic patching (only overwrite files, don't delete old files)

  • -i, --ignore-certificate-errors: Ignore SSL certificate validation errors

  • --timeout: Request timeout in seconds (default: 90)

Upload Folder

Upload a folder's contents to a workspace.

curiosity-cli upload-folder -s <server-url> -t <token> -p <path> [options]

  • -s, --server: Workspace URL (required)

  • -t, --token: Authentication token (required)

  • -p, --path: Source folder path (required)

  • --bandwidth: Maximum bandwidth in Mbps

  • --fetch-server-state: Sync with server state before upload

  • --source: Custom source name

  • --upload-to: Upload destination (Public/Group/UserPublic/UserPrivate)

  • --target-uid: Target group/user UID for non-public uploads

  • --extensions: Filtered file extensions (e.g., "doc;docx;pdf")

  • --root-path: Original root path to replace (local path)

  • --root-folder-name: Target root folder name (the path the root path is replaced with in the workspace)

  • --sync-file-url: Enable direct file URL synchronization

  • --in-place: Only sync file URLs without copying files

Monitor Folder

Monitor and continuously sync a folder to a workspace.

curiosity-cli monitor -s <server-url> -t <token> -p <path> [options]

[Similar options to upload-folder, but with continuous monitoring]

Upload/Monitor with Permissions (Windows Only)

Variants of upload and monitor commands that sync Windows file permissions:

curiosity-cli upload-folder-with-permissions -s <server-url> -t <token> -p <path> -c <permissions-cache> [options]
curiosity-cli monitor-with-permissions -s <server-url> -t <token> -p <path> -c <permissions-cache> [options]

Additional option:

  • -c, --permissions-cache: Path to permissions cache file to cache local permissions of the synced folder

Windows-specific options for impersonation:

Use a different user to access the files and folders to be synced. Works with the monitor and upload commands.

  • --username: Windows username

  • --password: Windows password

  • --domain: Windows domain

Inspect Folder

Analyze a folder's contents and generate a summary report.

curiosity-cli inspect -p <path>

  • -p, --path: Folder to analyze (required)

PST Ingestion

Upload emails from PST files to the workspace.

curiosity-cli ingest-pst -s <server-url> -t <token> -p <pst-file> [options]

  • -p, --path: PST file path (required)

  • --ignore-folders: Semicolon-separated list of folders to skip

Custom Code Management

Export and import custom code configurations like custom code indexes, custom endpoints or custom tasks:

curiosity-cli export-custom-code -s <server-url> -t <token> --output-file <path>
curiosity-cli import-custom-code -s <server-url> -t <token> --import-file <path>

Token Management

Store authentication tokens locally:

curiosity-cli store-token -s <server-url> -t <token>

After storing a token, you can use --token auto in other commands.

Serve Front-End

Locally serve a front-end project built with the Mosaik.FrontEnd package. Mostly used when developing a custom frontend for a workspace.

curiosity-cli serve -s <server-url> -p <path> [options]

  • -s, --server: Workspace URL

  • -p, --path: Path to front-end files

  • --name: Connector name (default: "Loc")

  • --port: Local port to bind (default: 5000)

  • --cert-file: SSL certificate file for HTTPS

  • --cert-password: SSL certificate password

  • --listen-to-any: Listen on all interfaces instead of just localhost

  • --enable-cors: Enable CORS

  • --path-base: Base path for the application

Common Options

Most commands support these options:

  • --timeout: Request timeout in seconds (default: 90)

Server URL Format

Server URLs should be in the format:

https://{path_to_workspace}/api/

Both HTTP and HTTPS are supported. The /api/ suffix will be added if omitted.

Windows-Specific Features

Some features are only available on Windows:

  • Permission synchronization

  • Windows authentication impersonation

  • Network share access with credentials

Notes

  • When specifying a server URL, both forward and backslashes are accepted, but forward slashes are preferred.

  • The server URL should end with "/api/", but the tool will attempt to correct this if omitted.

Logging Options

The following options are available for all commands:

  • --log-level: Set the minimum logging level (e.g., DEBUG, INFO, WARNING, ERROR)

  • --logs: Specify the directory path where log files should be stored

PreviousAuthenticationNextIntroduction

Last updated