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
541 lines
16 KiB
JSON
541 lines
16 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "mint",
|
|
"name": "Mirage",
|
|
"description": "Mirage gives AI agents one virtual filesystem for S3, Google Drive, Slack, GitHub, Notion, Postgres, and SSH, so shell commands work across services.",
|
|
"colors": {
|
|
"primary": "#0C0C0C",
|
|
"light": "#FAFAFA",
|
|
"dark": "#000000"
|
|
},
|
|
"logo": {
|
|
"light": "/logo/light.svg",
|
|
"dark": "/logo/dark.svg"
|
|
},
|
|
"favicon": "/favicon.svg",
|
|
"contextual": {
|
|
"options": [
|
|
"copy",
|
|
"view",
|
|
"chatgpt",
|
|
"claude",
|
|
"perplexity",
|
|
"mcp",
|
|
"cursor",
|
|
"vscode"
|
|
]
|
|
},
|
|
"seo": {
|
|
"metatags": {
|
|
"keywords": "Mirage, filesystem for AI agents, virtual filesystem, AI agent tools, agent infrastructure, MCP alternative, bash for agents, S3 filesystem, Google Drive filesystem, Slack filesystem, GitHub filesystem, agent sandbox, Strukto",
|
|
"author": "Strukto",
|
|
"robots": "index, follow",
|
|
"googlebot": "index, follow",
|
|
"canonical": "https://docs.mirage.strukto.ai",
|
|
"theme-color": "#0C0C0C",
|
|
"color-scheme": "light dark",
|
|
"language": "en",
|
|
"category": "Technology",
|
|
"target": "developers",
|
|
"apple-mobile-web-app-capable": "yes",
|
|
"apple-mobile-web-app-status-bar-style": "black-translucent",
|
|
"og:type": "website",
|
|
"og:url": "https://docs.mirage.strukto.ai",
|
|
"og:image": "https://raw.githubusercontent.com/strukto-ai/mirage/main/assets/mirage-og-light.png",
|
|
"og:image:alt": "Mirage virtual filesystem for AI agents",
|
|
"og:site_name": "Mirage",
|
|
"og:locale": "en_US",
|
|
"twitter:card": "summary_large_image",
|
|
"twitter:site": "@struktoai",
|
|
"twitter:creator": "@struktoai",
|
|
"twitter:image": "https://raw.githubusercontent.com/strukto-ai/mirage/main/assets/mirage-og-light.png",
|
|
"twitter:image:alt": "Mirage · Unified Virtual Filesystem for AI Agents | Strukto"
|
|
}
|
|
},
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Home",
|
|
"icon": "/images/mirage-icon-light.svg",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"home/introduction",
|
|
"home/install",
|
|
"home/cli"
|
|
]
|
|
},
|
|
{
|
|
"group": "Learn",
|
|
"pages": [
|
|
"home/architecture",
|
|
"home/bash",
|
|
"home/resource-matrix",
|
|
"home/cache",
|
|
"home/snapshot",
|
|
"home/observer",
|
|
"home/auth"
|
|
]
|
|
},
|
|
{
|
|
"group": "Help",
|
|
"pages": [
|
|
"home/troubleshooting"
|
|
]
|
|
},
|
|
{
|
|
"group": "Setup",
|
|
"pages": [
|
|
{
|
|
"group": "FUSE",
|
|
"icon": "hard-drive",
|
|
"pages": [
|
|
"home/setup/macos",
|
|
"home/setup/linux"
|
|
]
|
|
},
|
|
{
|
|
"group": "Object Storage",
|
|
"icon": "cloud",
|
|
"pages": [
|
|
"home/setup/s3",
|
|
"home/setup/r2",
|
|
"home/setup/gcs",
|
|
"home/setup/oci",
|
|
"home/setup/supabase",
|
|
"home/setup/minio",
|
|
"home/setup/ceph",
|
|
"home/setup/seaweedfs",
|
|
"home/setup/wasabi",
|
|
"home/setup/backblaze",
|
|
"home/setup/digitalocean",
|
|
"home/setup/tencent",
|
|
"home/setup/aliyun",
|
|
"home/setup/scaleway",
|
|
"home/setup/qingstor"
|
|
]
|
|
},
|
|
{
|
|
"group": "Hugging Face",
|
|
"icon": "/images/huggingface-logo.svg",
|
|
"pages": [
|
|
"home/setup/hf_buckets",
|
|
"home/setup/hf_datasets",
|
|
"home/setup/hf_models",
|
|
"home/setup/hf_spaces"
|
|
]
|
|
},
|
|
{
|
|
"group": "Google Workspace",
|
|
"icon": "google",
|
|
"pages": [
|
|
"home/setup/google"
|
|
]
|
|
},
|
|
{
|
|
"group": "Microsoft",
|
|
"icon": "microsoft",
|
|
"pages": [
|
|
"home/setup/onedrive",
|
|
"home/setup/sharepoint"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cloud Files",
|
|
"icon": "folder-open",
|
|
"pages": [
|
|
"home/setup/dropbox",
|
|
"home/setup/box",
|
|
"home/setup/nextcloud",
|
|
"home/setup/databricks"
|
|
]
|
|
},
|
|
{
|
|
"group": "Code & DevOps",
|
|
"icon": "code",
|
|
"pages": [
|
|
"home/setup/github",
|
|
"home/setup/github_ci",
|
|
"home/setup/linear",
|
|
"home/setup/langfuse"
|
|
]
|
|
},
|
|
{
|
|
"group": "Messaging",
|
|
"icon": "comments",
|
|
"pages": [
|
|
"home/setup/slack",
|
|
"home/setup/discord",
|
|
"home/setup/email"
|
|
]
|
|
},
|
|
{
|
|
"group": "Database",
|
|
"icon": "database",
|
|
"pages": [
|
|
"home/setup/mongodb",
|
|
"home/setup/postgres",
|
|
"home/setup/chroma",
|
|
"home/setup/lancedb",
|
|
"home/setup/qdrant"
|
|
]
|
|
},
|
|
{
|
|
"group": "Knowledge",
|
|
"icon": "brain",
|
|
"pages": [
|
|
"home/setup/dify"
|
|
]
|
|
},
|
|
{
|
|
"group": "Notes",
|
|
"icon": "book",
|
|
"pages": [
|
|
"home/setup/notion"
|
|
]
|
|
},
|
|
{
|
|
"group": "Others",
|
|
"icon": "ellipsis",
|
|
"pages": [
|
|
"home/setup/trello"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Python",
|
|
"icon": "/images/python-logo.svg",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"python/install",
|
|
"python/quickstart",
|
|
"python/setup/fuse"
|
|
]
|
|
},
|
|
{
|
|
"group": "Agents",
|
|
"icon": "robot",
|
|
"pages": [
|
|
"python/agents/index",
|
|
"python/agents/openai-agents",
|
|
"python/agents/langchain",
|
|
"python/agents/openhands",
|
|
"python/agents/pydantic-ai",
|
|
"python/agents/camel",
|
|
"python/agents/agno",
|
|
"python/agents/claude-code",
|
|
"python/agents/claude-agent-sdk",
|
|
"python/agents/codex"
|
|
]
|
|
},
|
|
{
|
|
"group": "Resources",
|
|
"pages": [
|
|
"python/resource/index",
|
|
{
|
|
"group": "Infrastructure",
|
|
"icon": "server",
|
|
"pages": [
|
|
"python/resource/disk",
|
|
"python/resource/ram",
|
|
"python/resource/redis",
|
|
"python/resource/ssh"
|
|
]
|
|
},
|
|
{
|
|
"group": "Object Storage",
|
|
"icon": "cloud",
|
|
"pages": [
|
|
"python/resource/s3",
|
|
"python/resource/r2",
|
|
"python/resource/gcs",
|
|
"python/resource/supabase",
|
|
"python/resource/oci",
|
|
"python/resource/minio",
|
|
"python/resource/ceph",
|
|
"python/resource/seaweedfs",
|
|
"python/resource/wasabi",
|
|
"python/resource/backblaze",
|
|
"python/resource/digitalocean",
|
|
"python/resource/tencent",
|
|
"python/resource/aliyun",
|
|
"python/resource/scaleway",
|
|
"python/resource/qingstor"
|
|
]
|
|
},
|
|
{
|
|
"group": "Hugging Face",
|
|
"icon": "/images/huggingface-logo.svg",
|
|
"pages": [
|
|
"python/resource/hf_buckets",
|
|
"python/resource/hf_datasets",
|
|
"python/resource/hf_models",
|
|
"python/resource/hf_spaces"
|
|
]
|
|
},
|
|
{
|
|
"group": "Google Workspace",
|
|
"icon": "google",
|
|
"pages": [
|
|
"python/resource/gmail",
|
|
"python/resource/gdrive",
|
|
"python/resource/gdocs",
|
|
"python/resource/gsheets",
|
|
"python/resource/gslides"
|
|
]
|
|
},
|
|
{
|
|
"group": "Microsoft",
|
|
"icon": "microsoft",
|
|
"pages": [
|
|
"python/resource/onedrive",
|
|
"python/resource/sharepoint"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cloud Files",
|
|
"icon": "folder-open",
|
|
"pages": [
|
|
"python/resource/nextcloud",
|
|
"python/resource/databricks_volume"
|
|
]
|
|
},
|
|
{
|
|
"group": "Code & DevOps",
|
|
"icon": "code",
|
|
"pages": [
|
|
"python/resource/github",
|
|
"python/resource/github_ci",
|
|
"python/resource/linear",
|
|
"python/resource/langfuse"
|
|
]
|
|
},
|
|
{
|
|
"group": "Messaging",
|
|
"icon": "comments",
|
|
"pages": [
|
|
"python/resource/slack",
|
|
"python/resource/discord",
|
|
"python/resource/email"
|
|
]
|
|
},
|
|
{
|
|
"group": "Database",
|
|
"icon": "database",
|
|
"pages": [
|
|
"python/resource/mongodb",
|
|
"python/resource/postgres",
|
|
"python/resource/chroma",
|
|
"python/resource/lancedb",
|
|
"python/resource/qdrant"
|
|
]
|
|
},
|
|
{
|
|
"group": "Knowledge",
|
|
"icon": "brain",
|
|
"pages": [
|
|
"python/resource/dify"
|
|
]
|
|
},
|
|
{
|
|
"group": "Notes",
|
|
"icon": "book",
|
|
"pages": [
|
|
"python/resource/notion"
|
|
]
|
|
},
|
|
{
|
|
"group": "Others",
|
|
"icon": "ellipsis",
|
|
"pages": [
|
|
"python/resource/trello"
|
|
]
|
|
},
|
|
"python/resource/new"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "TS",
|
|
"icon": "/images/typescript-logo.svg",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"typescript/install",
|
|
"typescript/quickstart",
|
|
"typescript/server-and-cli",
|
|
"typescript/setup/fuse",
|
|
"typescript/python",
|
|
"typescript/python-fs",
|
|
"typescript/limitations"
|
|
]
|
|
},
|
|
{
|
|
"group": "Agents",
|
|
"icon": "robot",
|
|
"pages": [
|
|
"typescript/agents/index",
|
|
"typescript/agents/openai",
|
|
"typescript/agents/langchain",
|
|
"typescript/agents/pi",
|
|
"typescript/agents/vercel",
|
|
"typescript/agents/mastra",
|
|
"typescript/agents/opencode",
|
|
"typescript/agents/claude-code",
|
|
"typescript/agents/claude-agent-sdk",
|
|
"typescript/agents/codex"
|
|
]
|
|
},
|
|
{
|
|
"group": "Resources",
|
|
"pages": [
|
|
{
|
|
"group": "Infrastructure",
|
|
"icon": "server",
|
|
"pages": [
|
|
"typescript/setup/disk",
|
|
"typescript/setup/opfs",
|
|
"typescript/setup/redis",
|
|
"typescript/setup/ssh"
|
|
]
|
|
},
|
|
{
|
|
"group": "Object Storage",
|
|
"icon": "cloud",
|
|
"pages": [
|
|
"typescript/setup/s3",
|
|
"typescript/setup/r2",
|
|
"typescript/setup/gcs",
|
|
"typescript/setup/oci",
|
|
"typescript/setup/supabase",
|
|
"typescript/setup/minio",
|
|
"typescript/setup/ceph",
|
|
"typescript/setup/seaweedfs",
|
|
"typescript/setup/wasabi",
|
|
"typescript/setup/backblaze",
|
|
"typescript/setup/digitalocean",
|
|
"typescript/setup/tencent",
|
|
"typescript/setup/aliyun",
|
|
"typescript/setup/scaleway",
|
|
"typescript/setup/qingstor"
|
|
]
|
|
},
|
|
{
|
|
"group": "Hugging Face",
|
|
"icon": "/images/huggingface-logo.svg",
|
|
"pages": [
|
|
"typescript/setup/hf_buckets",
|
|
"typescript/setup/hf_datasets",
|
|
"typescript/setup/hf_models",
|
|
"typescript/setup/hf_spaces"
|
|
]
|
|
},
|
|
{
|
|
"group": "Google Workspace",
|
|
"icon": "google",
|
|
"pages": [
|
|
"typescript/setup/gmail",
|
|
"typescript/setup/gdrive",
|
|
"typescript/setup/gdocs",
|
|
"typescript/setup/gsheets",
|
|
"typescript/setup/gslides"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cloud Files",
|
|
"icon": "folder-open",
|
|
"pages": [
|
|
"typescript/dropbox",
|
|
"typescript/box",
|
|
"typescript/setup/databricks_volume"
|
|
]
|
|
},
|
|
{
|
|
"group": "Code & DevOps",
|
|
"icon": "code",
|
|
"pages": [
|
|
"typescript/setup/github",
|
|
"typescript/setup/github_ci",
|
|
"typescript/setup/linear",
|
|
"typescript/setup/langfuse"
|
|
]
|
|
},
|
|
{
|
|
"group": "Messaging",
|
|
"icon": "comments",
|
|
"pages": [
|
|
"typescript/slack",
|
|
"typescript/discord",
|
|
"typescript/setup/email"
|
|
]
|
|
},
|
|
{
|
|
"group": "Database",
|
|
"icon": "database",
|
|
"pages": [
|
|
"typescript/setup/mongodb",
|
|
"typescript/setup/postgres",
|
|
"typescript/setup/chroma",
|
|
"typescript/setup/lancedb",
|
|
"typescript/setup/qdrant"
|
|
]
|
|
},
|
|
{
|
|
"group": "Notes",
|
|
"icon": "book",
|
|
"pages": [
|
|
"typescript/setup/notion"
|
|
]
|
|
},
|
|
{
|
|
"group": "Others",
|
|
"icon": "ellipsis",
|
|
"pages": [
|
|
"typescript/setup/trello"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"label": "mirage",
|
|
"icon": "globe",
|
|
"href": "https://www.strukto.ai/mirage"
|
|
},
|
|
{
|
|
"label": "Discord",
|
|
"icon": "discord",
|
|
"href": "https://discord.gg/u8BPQ65KsS"
|
|
},
|
|
{
|
|
"label": "",
|
|
"icon": "x-twitter",
|
|
"href": "https://x.com/struktoai"
|
|
},
|
|
{
|
|
"label": "strukto-ai/mirage",
|
|
"icon": "github",
|
|
"href": "https://github.com/strukto-ai/mirage"
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"github": "https://github.com/strukto-ai/mirage"
|
|
}
|
|
}
|
|
}
|