@struktoai/mirage-agents 0.0.1-alpha.2 → 0.0.1-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -6
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -2,15 +2,36 @@
2
2
  <img src="https://raw.githubusercontent.com/strukto-ai/mirage/main/assets/mirage-og-light@2x.png" alt="Mirage: A Unified Virtual File System for AI Agents" width="900">
3
3
  </p>
4
4
 
5
+ <p align="center">
6
+ <a href="https://docs.mirage.strukto.ai" alt="Documentation">
7
+ <img src="https://img.shields.io/badge/mirage-docs-0C0C0C?labelColor=FAFAFA" /></a>
8
+ <a href="https://www.strukto.ai" alt="Website">
9
+ <img src="https://img.shields.io/badge/made by-strukto.ai-0C0C0C?labelColor=FAFAFA" /></a>
10
+ <a href="https://github.com/strukto-ai/mirage/blob/main/LICENSE" alt="License">
11
+ <img src="https://img.shields.io/github/license/strukto-ai/mirage?color=0C0C0C&labelColor=FAFAFA" /></a>
12
+ <a href="https://discord.gg/u8BPQ65KsS" alt="Discord">
13
+ <img src="https://img.shields.io/badge/discord-join-0C0C0C?labelColor=FAFAFA&logo=discord&logoColor=0C0C0C" /></a>
14
+ <br/>
15
+ <a href="https://docs.mirage.strukto.ai/python/quickstart" alt="Python docs">
16
+ <img src="https://img.shields.io/badge/python-docs-0C0C0C?labelColor=FAFAFA&logo=python&logoColor=0C0C0C" alt="Python docs"></a>
17
+ <a href="https://pypi.org/project/mirage-ai/" alt="PyPI Version">
18
+ <img src="https://img.shields.io/pypi/v/mirage-ai.svg?color=0C0C0C&labelColor=FAFAFA"/></a>
19
+ <br/>
20
+ <a href="https://docs.mirage.strukto.ai/typescript/quickstart" alt="TypeScript docs">
21
+ <img src="https://img.shields.io/badge/typescript-docs-0C0C0C?labelColor=FAFAFA&logo=typescript&logoColor=0C0C0C" alt="TypeScript docs"></a>
22
+ <a href="https://www.npmjs.com/package/@struktoai/mirage-agents" alt="NPM Version">
23
+ <img src="https://img.shields.io/npm/v/%40struktoai%2Fmirage-agents.svg?color=0C0C0C&labelColor=FAFAFA"/></a>
24
+ </p>
25
+
5
26
  Mirage is **a Unified Virtual File System for AI Agents**: a single tree that mounts services and data sources like S3, Google Drive, Slack, Gmail, and Redis side-by-side as one filesystem.
6
27
 
7
28
  AI agents reach every backend with the same handful of Unix-like tools, and pipelines compose across services as naturally as on a local disk. It's a simulated environment, agents see one filesystem underneath. Any LLM that already knows bash can use Mirage out of the box, with zero new vocabulary.
8
29
 
9
30
  ```ts
10
31
  const ws = new Workspace({
11
- '/data': new RAMResource(),
12
- '/s3': new S3Resource({ bucket: 'logs' }),
13
- '/slack': new SlackResource({}),
32
+ '/data': new RAMResource(),
33
+ '/s3': new S3Resource({ bucket: 'logs' }),
34
+ '/slack': new SlackResource({}),
14
35
  '/github': new GitHubResource({}),
15
36
  })
16
37
 
@@ -120,10 +141,10 @@ import {
120
141
  } from '@struktoai/mirage-browser'
121
142
 
122
143
  const ws = new Workspace({
123
- '/data': new RAMResource(),
124
- '/s3': new S3Resource({ bucket: 'my-bucket' }),
144
+ '/data': new RAMResource(),
145
+ '/s3': new S3Resource({ bucket: 'my-bucket' }),
125
146
  '/slack': new SlackResource({}),
126
- '/docs': new GDocsResource({}),
147
+ '/docs': new GDocsResource({}),
127
148
  })
128
149
 
129
150
  await ws.execute('cp /s3/report.csv /data/report.csv')
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@struktoai/mirage-agents",
3
- "version": "0.0.1-alpha.2",
3
+ "version": "0.0.1-alpha.4",
4
4
  "description": "A Unified Virtual Filesystem For AI Agents",
5
5
  "keywords": [
6
6
  "bash",
@@ -64,7 +64,7 @@
64
64
  ],
65
65
  "dependencies": {
66
66
  "picomatch": "^4.0.4",
67
- "@struktoai/mirage-core": "0.0.1-alpha.2"
67
+ "@struktoai/mirage-core": "0.0.1-alpha.3"
68
68
  },
69
69
  "peerDependencies": {
70
70
  "@mariozechner/pi-ai": "^0.70.0",
@@ -87,7 +87,7 @@
87
87
  "typescript": "^6.0.0",
88
88
  "vitest": "^3.0.0",
89
89
  "zod": "^4.0.0",
90
- "@struktoai/mirage-node": "0.0.1-alpha.2"
90
+ "@struktoai/mirage-node": "0.0.1-alpha.4"
91
91
  },
92
92
  "scripts": {
93
93
  "build": "tsup",