Mascope CLI

The operations CLI for Mascope, Karsa's mass-spectrometry analysis platform. It installs, launches, backs up and manages a Mascope deployment — the application itself runs as Docker containers pulled from the project's registry.

Requirements

• Python 3.12
• Docker (with the compose plugin)

Quickstart

pip install mascope-cli

mascope init        # create a runtime home: config, compose files, secrets
mascope cert gen    # self-signed TLS cert (or install real certs)
mascope prod up     # pull and start the production stack

mascope init creates the runtime home at ~/.mascope (%LOCALAPPDATA%\Mascope on Windows) — configuration TOMLs you can edit, docker compose files, and generated application secrets. Set MASCOPE_PATH to place it elsewhere. Re-running init is safe: existing files are kept and secrets are never regenerated.

To try Mascope without a deployment, the self-contained demo stack ships in the runtime home as well:

docker compose -f docker-compose.demo.yaml up -d
# then open http://localhost:8080 — login demo@mascope.app / mascope-demo

Everyday operations

mascope prod ps                  # container status
mascope prod logs --follow       # stream logs
mascope prod update              # update the stack to the latest release
mascope prod db backup           # dump the database
mascope prod db restore --yes    # restore the latest dump
mascope logs query --grep error  # search the application's file logs
mascope env list                 # manage runtime environments

Run mascope --help or mascope <command> --help for the full reference.

mascope prod update pulls the target release images, restarts the stack with them and runs any pending database migrations (preceded by an automatic pre-migration dump). Move to a specific release with mascope prod update --version v1.2.0, or pin the deployed version for all commands with MASCOPE_VERSION; without a pin the stack follows the latest release images.

Development

The Mascope source checkout exposes additional developer commands (dev, test, agent, backend) that operate on the monorepo; they are not part of the standalone install. See the repository for the developer guide.