Available on NuGet Read more

Curiosity CLI

The official command-line tool for the Curiosity Workspace. Test connections, upload front-ends, ingest folders, sync git trackers, and export/import workspace definitions from any shell or CI pipeline.

Install Common Options

What is `curiosity-cli`?

curiosity-cli is a dotnet global tool packaged as the NuGet package Curiosity.CLI. It exposes every operation you would otherwise script against the Workspace's HTTP / Graph API, with consistent --server / --token arguments and kebab-case command names.

Use it to:

Promote a custom front-end bundle between environments.
Iterate on a custom front-end locally while talking to a remote workspace.
Ingest files (folders, PSTs) into a workspace, with or without Active Directory ACLs.
Export and import custom code (endpoints, indexes, scheduled tasks) between workspaces — the foundation of GitOps-style workspace deployments.
Wait for a workspace to become ready, then run smoke tests, inside a CI/CD pipeline.

Install

dotnet tool install Curiosity.CLI --global

Then confirm:

curiosity-cli --help

Full instructions, update path, and offline install on Installation.

Common arguments

Almost every command takes the same two arguments — a workspace URL and a Library Token:

curiosity-cli <command> \
  --server https://my-workspace.example.com/ \
  --token  $CURIOSITY_TOKEN

Short forms -s and -t work everywhere. Tokens can also be stored encrypted on disk with store-token so you can pass --token auto afterwards.

See Common Options for the full list (timeouts, mTLS, ignore-certificate-errors, environment variables, logging).

Commands

test

Verify the URL and token by running a tiny query against the workspace.

store-token

Encrypt and store a token locally so commands can use --token auto.

wait-for

Block until a workspace's readiness probe returns true — useful in CI.

serve

Serve a locally built custom front-end and proxy API calls to a remote workspace.

upload-front-end

Push a compiled Mosaik.FrontEnd bundle to a workspace.

inspect

Report supported and unsupported files in a folder before ingestion.

upload-folder

One-shot upload of a folder into the workspace.

monitor

Keep a folder continuously in sync with the workspace.

upload-folder-with-permissions

Windows: one-shot upload that also propagates Active Directory ACLs.

monitor-with-permissions

Windows: continuous sync that keeps ACLs aligned with Active Directory.

ingest-pst

Extract emails and attachments from a PST file and upload them.

git-sync

Serve a local git repository to a workspace's git-tracker.

export-workspace-definitions

Download custom tasks, indexes, and endpoints as a zip or directory.

import-workspace-definitions

Upload custom tasks, indexes, and endpoints back into a workspace.

Where to go next

Building a custom UI? Start with Custom Front-End development workflow — it uses serve and upload-front-end end-to-end.
Ingesting an existing share or PST archive? See inspect first, then upload-folder or ingest-pst.
Moving custom code between dev, staging, and prod? See export-workspace-definitions and import-workspace-definitions.
Need to wait for the workspace before running smoke tests in CI? See wait-for and Workspace deployment operations.