wehub-resource-sync
bcbd1bdb22
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
3.0 KiB
3.0 KiB
Mirage CLI
mirage is the command-line client for the Mirage daemon. It talks to a local
daemon over HTTP and auto-spawns one on first use if none is running.
Basic usage
# A minimal workspace config (workspace.yaml)
cat > workspace.yaml <<'YAML'
mounts:
/:
resource: ram
mode: WRITE
YAML
# Create a workspace (spawns the daemon if needed)
mirage workspace create ./workspace.yaml --id myws
# Run a command in it
mirage execute -w myws -c 'echo hello'
# Inspect / clean up
mirage workspace list
mirage workspace get myws
mirage workspace delete myws
# Stop the daemon
mirage daemon stop
Other command groups: session, provision, daemon, plus
workspace clone|snapshot|load. Run mirage <command> --help for details.
Environment variables
| Variable | Default | Purpose |
|---|---|---|
MIRAGE_DAEMON_URL |
http://127.0.0.1:8765 |
Daemon address the CLI connects to |
MIRAGE_TOKEN |
(none) | Bearer token the CLI sends to the daemon |
MIRAGE_AUTH_MODE |
local |
Daemon auth mode: local, token, or jwt |
MIRAGE_AUTH_TOKEN |
(auto-minted in local) |
Token the daemon accepts |
MIRAGE_IDLE_GRACE_SECONDS |
30 |
Seconds the daemon waits after its last workspace is removed before shutting down |
MIRAGE_ALLOWED_HOSTS |
127.0.0.1,localhost,::1 |
Daemon Host-header allowlist (CSV; * disables the check) |
MIRAGE_DAEMON_PORT |
8765 |
Port the spawned daemon binds |
MIRAGE_PID_FILE |
~/.mirage/daemon.pid |
Daemon pid file location |
MIRAGE_VERSION_ROOT |
~/.mirage/repos |
Bare git repos backing workspace versioning |
MIRAGE_SNAPSHOT_ROOT |
~/.mirage/snapshots |
Snapshot storage root |
Every daemon setting (except the bootstrap MIRAGE_HOME and raw
secrets) can also live in ~/.mirage/config.toml under [daemon],
managed with mirage config list|get|set|unset. Per key the
precedence is: env var > config.toml > default. mirage config list --resolved prints the effective value of every key and where it came
from. The daemon validates the [daemon] table at startup and
refuses to start on unknown keys or malformed TOML; mirage config unset <key> accepts unknown keys so a broken file can be repaired.