Curiosity CLI

The Curiosity CLI (curiosity-cli) is a command-line tool for interacting with the Curiosity Workspace. It lets you manage deployments, ingest data, promote custom code between environments, and run administrative tasks.

Full reference

A page-per-command reference now lives under Developer Resources → Curiosity CLI. This page is a short cheat sheet from the customization angle; jump to /cli/ for installation, common options, and every flag of every command.

Installation

Install as a global .NET tool:

dotnet tool install Curiosity.CLI --global

Update later with:

dotnet tool update Curiosity.CLI --global

Full instructions, including local manifest installs and CI usage: Installation.

Common arguments

Most commands take the same two arguments to reach a workspace:

--server / -s — the URL of your workspace (e.g., https://my-workspace.example.com/).
--token / -t — a Library Token, created under Manage → Tokens → Library. Pass auto to read a previously stored token.
--timeout — per-request timeout in seconds (default: 90).

Quick reference

Command	Purpose
`test`	Verify URL + token by running a tiny query.
`store-token`	Encrypt and store a token so other commands can use `--token auto`.
`wait-for`	Block until the workspace's readiness probe returns `true`.
`serve`	Serve a local custom-front-end bundle and proxy API calls to a remote workspace.
`upload-front-end`	Push a compiled `Mosaik.FrontEnd` bundle to a workspace.
`inspect`	Report supported/unsupported files in a folder before ingestion.
`upload-folder`	One-shot ingest of a local folder.
`monitor`	Continuous folder sync.
`upload-folder-with-permissions`	Windows: one-shot ingest that also propagates Active Directory ACLs.
`monitor-with-permissions`	Windows: continuous sync that keeps ACLs aligned with AD.
`ingest-pst`	Extract emails from a PST archive and upload them.
`git-sync`	Serve a local git repo to the 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.

Typical workflows from a customization perspective

Promote a custom front-end — serve locally, then upload-front-end per environment. See the end-to-end loop in Development Workflow.
Promote custom code (endpoints, tasks, indexes) — export-workspace-definitions from dev, commit the artifact, import-workspace-definitions into staging/prod.
Ingest a network share — inspect first, then upload-folder or monitor. For AD-permissioned shares on Windows, use the *-with-permissions variants.

Referenced by

development-workflow