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
78 lines
1.9 KiB
Plaintext
78 lines
1.9 KiB
Plaintext
---
|
|
title: Installation
|
|
description: Install Mirage for Python with mirage-ai from PyPI or uv, then add extras for S3, Redis, FUSE, Google Workspace, and other resources.
|
|
keywords: ["mirage-ai", "Python virtual filesystem", "AI agents", "S3 filesystem", "FUSE", "agent tools"]
|
|
icon: download
|
|
---
|
|
|
|
## Quick Install
|
|
|
|
Install the base package into your project:
|
|
|
|
```bash
|
|
uv add mirage-ai
|
|
```
|
|
|
|
This is enough to start with local workflows such as the RAM resource and to understand the Mirage execution model.
|
|
|
|
If you are not using uv:
|
|
|
|
```bash
|
|
pip install mirage-ai
|
|
```
|
|
|
|
## Use Mirage as a CLI
|
|
|
|
If you only want the `mirage` CLI (not the library), there are two convenient paths.
|
|
|
|
**One-shot run with `uvx`**, no install, just runs:
|
|
|
|
```bash
|
|
uvx mirage-ai --help
|
|
uvx mirage-ai workspace create workspace.yaml --id demo
|
|
```
|
|
|
|
**Persistent install with `uv tool install`**, drops `mirage` on your PATH globally:
|
|
|
|
```bash
|
|
uv tool install mirage-ai
|
|
mirage --help
|
|
```
|
|
|
|
To upgrade later:
|
|
|
|
```bash
|
|
uv tool install --upgrade mirage-ai
|
|
```
|
|
|
|
## Resource Extras
|
|
|
|
Install extras when a resource needs optional dependencies:
|
|
|
|
```bash
|
|
uv add "mirage-ai[s3]"
|
|
uv add "mirage-ai[r2]"
|
|
uv add "mirage-ai[redis]"
|
|
uv add "mirage-ai[fuse]"
|
|
```
|
|
|
|
Use the resource docs in the Python section when you are ready to connect real systems.
|
|
|
|
## Install From Source
|
|
|
|
If you are contributing to Mirage or want the full local development setup:
|
|
|
|
```bash
|
|
git clone https://github.com/strukto-ai/mirage.git
|
|
cd mirage/python
|
|
uv sync --all-extras --no-extra camel
|
|
```
|
|
|
|
The `camel` extra conflicts with the `openai` stack, so excluding it keeps everything else installable in one shot.
|
|
|
|
## Recommended Path
|
|
|
|
1. Install the base package.
|
|
2. Follow the [Python Quickstart](/python/quickstart) with the RAM resource.
|
|
3. Add the resource extras and follow the [FUSE setup](/python/setup/fuse) if you need to expose mounts as a real filesystem.
|