|
1 | | -# ClawDrive |
| 1 | +<div align="center"> |
2 | 2 |
|
3 | | -**Google Drive for AI agents.** Store any file — PDFs, images, video, audio, text — and search by meaning across modalities. |
| 3 | +<img src="https://raw.githubusercontent.com/Hyper3Labs/clawdrive/main/assets/banner.png" alt="ClawDrive — Google Drive for AI agents" width="600" /> |
4 | 4 |
|
5 | 5 | [](https://github.com/hyper3labs/clawdrive/blob/main/LICENSE) |
6 | 6 | [](https://github.com/hyper3labs/clawdrive/releases) |
| 7 | +[](https://deepwiki.com/Hyper3Labs/clawdrive) |
| 8 | +[](https://discord.gg/Za3rBkTPSf) |
7 | 9 |
|
8 | | -[Website](https://claw3drive.com) · [Live Demo](https://app.claw3drive.com/) |
| 10 | +[Website](https://claw3drive.com) · [Documentation](https://github.com/hyper3labs/clawdrive/blob/main/CLI.md) · [Live Demo](https://app.claw3drive.com/) · [Report Bug](https://github.com/hyper3labs/clawdrive/issues/new?template=bug_report.md) · [Request Feature](https://github.com/hyper3labs/clawdrive/issues/new?template=feature_request.md) |
| 11 | + |
| 12 | +</div> |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +<div align="center"> |
| 17 | +<img src="https://raw.githubusercontent.com/Hyper3Labs/clawdrive/main/assets/demo.gif" alt="ClawDrive 3D file cloud demo" width="700" /> |
| 18 | + |
| 19 | +<br/> |
| 20 | +<br/> |
| 21 | +Browse files by meaning, not folders. |
| 22 | + |
| 23 | +</div> |
| 24 | + |
| 25 | +## What is ClawDrive? |
| 26 | + |
| 27 | +**ClawDrive** indexes your files (text, images, audio, video) and makes them searchable by meaning. You interact with it through a CLI, a REST API, or a browser UI with a 3D file cloud. |
| 28 | + |
| 29 | +Files live in **pots**. A pot is a named collection you build from files, folders, or URLs. Search and sharing are both scoped to the pot — nothing else on your machine is visible. |
| 30 | + |
| 31 | +> Everything runs on your machine. The only external call is to Gemini for embeddings. For remote access, point a tunnel at the local server. |
| 32 | +
|
| 33 | +## Features |
| 34 | + |
| 35 | +- **Multimodal Shared Representation:** Text, images, audio, and video all live in the same embedding space. |
| 36 | +- **Cross-Modal Retrieval:** Search your files by meaning—use text to find images, or images to find text. |
| 37 | +- **Bring-Your-Own Transcriber:** Attach transcripts (e.g., from WhisperX) directly to audio and video files for deep indexing. |
| 38 | +- **Tiered Retrieval System:** Save LLM context windows. ClawDrive returns a 1-sentence `tldr` or a markdown `digest` before you fetch the full file. |
| 39 | +- **3D Visualization & Web UI:** Browse your files spatially with an interactive 3D frontend. |
| 40 | +- **Pot-Based Local Sharing:** Group files into isolated "pots". Share contexts directly peer-to-peer via local tunnels (Tailscale, Cloudflare). |
| 41 | +- **Auto File Naming & Organization:** Import everything cleanly without UUIDs; duplicates are automatically suffixed and organized. |
9 | 42 |
|
10 | 43 | ## Quick Start |
11 | 44 |
|
12 | 45 | ```bash |
| 46 | +# Install globally (requires ffmpeg for audio/video: brew install ffmpeg) |
13 | 47 | npm install -g clawdrive |
14 | 48 |
|
| 49 | +# Set your Gemini API key |
15 | 50 | export GEMINI_API_KEY="your-key-here" |
16 | 51 |
|
17 | | -# Launch the web UI with a curated NASA demo |
18 | | -clawdrive serve --demo nasa |
19 | | - |
20 | | -# For a read-only hosted demo, add --read-only |
21 | | -clawdrive serve --demo nasa --read-only |
| 52 | +# Launch the web UI with a curated NASA demo (~248 MB on first run) |
| 53 | +cdrive serve --demo nasa |
22 | 54 | ``` |
23 | 55 |
|
| 56 | +The npm package is `clawdrive`; the installed CLI command is `cdrive`. |
| 57 | + |
24 | 58 | Or run directly without installing: |
25 | 59 |
|
26 | 60 | ```bash |
27 | | -npx clawdrive serve --demo nasa |
| 61 | +npx --package clawdrive cdrive serve --demo nasa |
28 | 62 | ``` |
29 | 63 |
|
| 64 | +Prefer the hosted version? Try the live demo at [app.claw3drive.com](https://app.claw3drive.com/). |
| 65 | + |
30 | 66 | > Get a free Gemini API key at [aistudio.google.com/apikey](https://aistudio.google.com/apikey) |
31 | 67 |
|
32 | | -## Features |
| 68 | +## Pots and sharing |
| 69 | + |
| 70 | +A pot can be anything — a specific codebase, a side-project workspace, or a feature's design docs. All search and sharing happens at the pot level, so you never accidentally expose files outside of it. |
33 | 71 |
|
34 | | -- **Multimodal semantic search** — query across text, images, video, and audio with natural language |
35 | | -- **Cross-modal retrieval** — find documents related to a photo, or videos matching a text description |
36 | | -- **Pots** — named, shareable file collections with fine-grained access control |
37 | | -- **3D file cloud** — interactive Three.js visualization with UMAP-projected embeddings |
38 | | -- **Agent-native sharing** — time-limited shares with read/write roles |
39 | | -- **REST API** — full programmatic access for integration with any tool or agent |
40 | | -- **CLI-first** — every feature accessible from the terminal, with `--json` output for scripting |
| 72 | +For remote access, put a tunnel in front of the local server (Tailscale, Cloudflare, etc.) — see [tunnels guide](https://github.com/hyper3labs/clawdrive/blob/main/skills/clawdrive/tunnels.md) for options. Storage stays on your machine. |
41 | 73 |
|
42 | | -## Usage |
| 74 | +## Ingest pipeline |
| 75 | + |
| 76 | +When you add files to a pot, ClawDrive turns them into something agents can actually search. Text gets chunked and summarized, audio and video get transcribed, and images become part of the same index. |
| 77 | + |
| 78 | +<div align="center"> |
| 79 | + <img src="https://raw.githubusercontent.com/Hyper3Labs/clawdrive/main/assets/ingest-pipeline.png" alt="ClawDrive shared search space: documents, images, audio, and video map to a shared semantic space allowing cross-modal retrieval" width="1100" /> |
| 80 | +</div> |
| 81 | + |
| 82 | +Supported formats: PDF, Markdown, TXT, JSON, JPG, PNG, GIF, WebP, SVG, MP4, MOV, WebM, MP3, WAV. |
| 83 | + |
| 84 | +## Tiered retrieval |
| 85 | + |
| 86 | +Agents don't need to read an entire file to decide if it's relevant. ClawDrive returns a one-line `tldr` with every search hit, a longer `digest` on request, and the full original only when you actually need it. |
| 87 | + |
| 88 | +<div align="center"> |
| 89 | + <img src="https://raw.githubusercontent.com/Hyper3Labs/clawdrive/main/assets/retrieval-tiers.png" alt="ClawDrive tiered retrieval: agents start with a TLDR, fetch a digest when needed, and open the original file only for exact text" width="1100" /> |
| 90 | +</div> |
| 91 | + |
| 92 | +## CLI quick reference |
| 93 | + |
| 94 | +| Command | Description | |
| 95 | +|---------|-------------| |
| 96 | +| `cdrive pot create <name>` | Create a pot for a project, dataset, or working set. | |
| 97 | +| `cdrive add --pot <pot> <sources...>` | Import files, folders, or URLs into a pot. | |
| 98 | +| `cdrive search [query] --pot <pot>` | Search by meaning, scoped to one pot when you want it. | |
| 99 | +| `cdrive search --file <path>` | Use an image, PDF, audio, or video file as the query. | |
| 100 | +| `cdrive get <file-or-share>` | Read a file by canonical name, or inspect a share by id or token. | |
| 101 | +| `cdrive todo [--kind <kinds>]` | Find files still missing agent-written metadata such as `tldr`, `digest`, or `transcript`. | |
| 102 | +| `cdrive tldr <file>` | Show or update the short summary attached to a file. | |
| 103 | +| `cdrive share pot <pot> --to <principal>` | Create a pot-scoped share for a person or agent. | |
| 104 | +| `cdrive share pot <pot> --link` | Create a pending link share you can approve and send out. | |
| 105 | +| `cdrive install-skill [--agent <name>]` | Install the bundled ClawDrive skill for Claude Code, Copilot, or Codex. | |
| 106 | +| `cdrive doctor` | Check the local workspace for configuration or health issues. | |
| 107 | +| `cdrive serve [--demo nasa]` | Start the local API and 3D web UI, optionally in demo mode. | |
| 108 | + |
| 109 | +Full command reference: **[CLI.md](https://github.com/hyper3labs/clawdrive/blob/main/CLI.md)** · REST API runs on the same port (`/api/*`) |
| 110 | + |
| 111 | +Every command also supports `--json`: |
43 | 112 |
|
44 | 113 | ```bash |
45 | | -clawdrive pot create acme-dd |
46 | | -clawdrive add --pot acme-dd ./contracts ./docs |
47 | | -clawdrive search "the nda we sent acme" --pot acme-dd |
48 | | -clawdrive search --image ./photo.jpg |
49 | | -clawdrive share pot acme-dd --to claude-code --role read --expires 24h |
50 | | -clawdrive serve |
| 114 | +$ cdrive search "launch telemetry" --json |
| 115 | +``` |
| 116 | +```json |
| 117 | +[ |
| 118 | + { |
| 119 | + "id": "file_01...", |
| 120 | + "file": "apollo-11-transcript.pdf", |
| 121 | + "contentType": "application/pdf", |
| 122 | + "tldr": "Full transcript of Apollo 11 comms...", |
| 123 | + "score": 0.94 |
| 124 | + } |
| 125 | +] |
51 | 126 | ``` |
52 | 127 |
|
53 | | -Both `clawdrive` and `cdrive` work as the CLI command. |
54 | | - |
55 | | -## Requirements |
| 128 | +## Community |
56 | 129 |
|
57 | | -- **Node.js 18+** |
58 | | -- **ffmpeg** — for video and audio processing |
59 | | -- **Gemini API key** — for multimodal embeddings ([get one free](https://aistudio.google.com/apikey)) |
| 130 | +Join the [Discord](https://discord.gg/Za3rBkTPSf) to ask questions, share what you're building, and follow development. |
60 | 131 |
|
61 | | -## Documentation |
| 132 | +## Contributing |
62 | 133 |
|
63 | | -Full documentation, CLI reference, and architecture details at **[github.com/hyper3labs/clawdrive](https://github.com/hyper3labs/clawdrive)**. |
| 134 | +See [CONTRIBUTING.md](https://github.com/hyper3labs/clawdrive/blob/main/CONTRIBUTING.md) for guidelines. |
64 | 135 |
|
65 | 136 | ## License |
66 | 137 |
|
67 | | -[MIT](https://github.com/hyper3labs/clawdrive/blob/main/LICENSE) — Copyright 2026 hyper3labs |
| 138 | +MIT — see [LICENSE](https://github.com/hyper3labs/clawdrive/blob/main/LICENSE) for details. |
| 139 | + |
| 140 | +--- |
| 141 | + |
| 142 | +<div align="center"> |
| 143 | + |
| 144 | +[](https://github.com/hyper3labs/clawdrive) |
| 145 | + |
| 146 | +Built by [Daniil](https://x.com/moroz_i_holod) & [Matin](https://x.com/MatinMnM) in Berlin. |
| 147 | + |
| 148 | +</div> |
0 commit comments