vaan-ai 0.1.0

package/LICENSE

@@ -0,0 +1,216 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   Copyright 2026 Vaan AI contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,390 @@
+# ☁️ Vaan AI
+
+**Your terminal, with an AI that can actually do the work.**
+
+Vaan is a local-first AI agent for your terminal — built to think, act, remember, and explain what
+it did.
+
+Give Vaan a task. It can inspect your project, use tools, modify code, run tests, remember context,
+and show you exactly what happened.
+
+```text
+You
+ ↓
+☁️ Vaan
+ ↓
+🧠 Think → 🔧 Act → 🔐 Permission → 📦 Sandbox
+ ↓
+🧪 Test → 🔍 Verify → 📋 Explain
+ ↓
+✓ Done
+```
+
+---
+
+## 🚀 Get Started
+
+```bash
+git clone https://github.com/balagurunilacandane/vaan-ai.git
+cd vaan-ai && npm install && npm run build && npm link
+```
+
+Then, from any project:
+
+```bash
+cd ~/projects/my-app
+vaan
+```
+
+That's it.
+
+> **Not on npm yet.** Once the first release is published this becomes `npx vaan`.
+
+**What you need**
+
+- **Node 20 or newer.**
+- **One provider** — an API key for Anthropic, OpenAI, Google or Groq, or
+  [Ollama](https://ollama.com) running locally, which needs no key at all.
+- **A C++ toolchain, occasionally.** Memory is SQLite with FTS5, so there's one native dependency.
+  Almost every platform gets a prebuilt binary; if yours doesn't, the install says so and tells you
+  what to install.
+
+Vaan starts with an interactive onboarding experience instead of making you configure everything
+manually.
+
+---
+
+## 🧭 Interactive Onboarding
+
+When you run `vaan` for the first time, it walks you through:
+
+```text
+☁️ Welcome to Vaan AI
+
+Let's get you set up.
+
+┌─────────────────────────────────────┐
+│ 1. 📁 Workspace                     │
+│    ~/projects/my-app                │
+│                                     │
+│ 2. 🤖 Model                         │
+│    anthropic/claude-opus-5          │
+│                                     │
+│ 3. 🔑 Credentials                   │
+│    ● Configure provider             │
+│                                     │
+│ 4. 👤 Agent Identity                │
+│    Vaan                             │
+│                                     │
+│ 5. 🧠 Memory                        │
+│    ● Enabled                        │
+│                                     │
+│ 6. 🧰 Tools                         │
+│    ✓ Files   ✓ Search   ✓ Git      │
+│    ✓ Web     ✓ Code     ✓ Memory   │
+│    ○ Browser        (not yet)       │
+│    ○ Integrations   (not yet)       │
+│                                     │
+│ 7. 📦 Coding Sandbox                │
+│    ● Restricted                     │
+│                                     │
+│ 8. 🔐 Permissions                   │
+│    ● Configure                      │
+│                                     │
+│ 9. ⚙️ Project Configuration          │
+│    ● SOUL.md / GUARDRAILS.md        │
+└─────────────────────────────────────┘
+
+✓ Vaan is ready.
+```
+
+A group you switch off doesn't exist. The model isn't told about a tool it may not use and then
+refused — it simply doesn't have one.
+
+---
+
+## 🤖 Bring your own model
+
+Choose the model you actually want to use:
+
+```text
+anthropic/claude-opus-5
+openai/gpt-5
+google/gemini-2.5-pro
+ollama/qwen3:8b
+custom/your-model
+```
+
+Cloud or local. No model lock-in, and no allowlist of model names anywhere in the codebase — the
+prefix picks an adapter, everything after the slash is passed through untouched. A model released
+tomorrow works today.
+
+---
+
+## ⚡ Give it real work
+
+```text
+> Add rate limiting to /api/auth/login.
+> Use Redis if it's already available.
+> Add tests and run them.
+```
+
+Vaan:
+
+```text
+🧠 Thinking...
+🔎 Inspecting project...
+🔍 Searching for Redis...
+📋 Planning changes...
+
+✓ Redis found
+✓ Express detected
+✓ Test framework detected
+```
+
+Then it asks — naming the exact file, not "some files":
+
+```text
+🔐 Permission required
+
+  Vaan wants to modify:
+
+    src/auth/login.ts
+
+  Permission:
+    WRITE
+
+  changing a file in the workspace
+
+  Allow?  [y/N]
+```
+
+Say yes and you get the diff before a byte is written. Say no and it tells you what it needed and
+stops, rather than looking for another way round.
+
+After approval:
+
+```text
+📦 Coding sandbox
+
+✓ Updated authentication
+✓ Added rate limiting
+✓ Added tests
+✓ Ran test suite
+
+🧪 18 tests passed
+
+🔍 Verifying...
+
+✓ No unrelated files changed
+✓ Rate limiting active
+✓ Tests passing
+
+📋 Done.
+
+Request ID: 7f3e9b4a
+```
+
+Not just "here's some code."
+
+**Intent → Plan → Permission → Execute → Test → Verify → Explain**
+
+---
+
+## ✨ Why Vaan?
+
+**🧠 Think** — Multi-step reasoning and planning.
+
+**🔧 Act** — Files, search, Git, web and commands. *No shell:* commands are tokenised in-process and
+spawned with `shell: false`, so the argv you approve is the argv that runs. No pipe, no redirect, no
+`&&` tail that nobody read.
+
+**💾 Remember** — Persistent, local, searchable project memory.
+
+**🔐 Stay in control** — Permissions are enforced by the runtime, not by the model.
+
+**📦 Code safely** — Coding operations run inside a restricted sandbox.
+
+**👀 See everything** — Every request gets a unique Request ID and an end-to-end trace.
+
+**🤖 Use any model** — Cloud models, local models, or your own provider.
+
+**🏠 Local-first** — Your agent state, memory and traces live with your workspace, in `.vaan/`.
+
+---
+
+## 🔐 Security
+
+Vaan's architecture separates the agent runtime from the coding sandbox.
+
+```text
+             ☁️ Vaan
+                │
+        ┌───────┴───────┐
+        │               │
+     🧠 Agent        🔐 Policy
+     Runtime          Engine
+        │               │
+        └───────┬───────┘
+                ↓
+        📦 Coding Sandbox
+        ├── 📁 Files
+        ├── ⚙️ Processes
+        ├── 📦 Dependencies
+        ├── 🧪 Tests
+        └── 🏗️ Builds
+```
+
+**The model cannot approve its own actions.** Not as a policy in a prompt — the approver is a
+function closed over your terminal, held in the runtime's own scope. No tool receives it and nothing
+the model emits can reach it. A tool can ask; only a person can answer.
+
+**Some rules are not configurable.** No config file, onboarding checkbox or skill can turn these
+off:
+
+- Credential material is never read — `.env`, `.ssh/`, `.aws/`, `.npmrc`, wherever they sit, even
+  inside your workspace
+- System changes are out of reach, and so are `/etc`, `/dev` and `/proc`
+- Commands that format a disk, delete the filesystem root or pipe a download into a shell are
+  refused outright — no approval prompt, because there is no good answer to one
+
+Credentials are isolated, stripped from the environment any sandboxed command inherits, and excluded
+from traces — redaction happens as events are written, not when they're read.
+
+`SOUL.md` and `GUARDRAILS.md` define behavior. **They are not security boundaries.** The limits that
+actually hold are in `src/sandbox/` and `src/permissions/`.
+
+---
+
+## 👀 Built-in Observability
+
+Every request gets a unique ID:
+
+```text
+Request ID: 7f3e9b4a
+```
+
+You can inspect what happened:
+
+```bash
+vaan trace 7f3e9b4a
+```
+
+```text
+Request
+ ↓
+Model
+ ↓
+Memory
+ ↓
+Tool calls
+ ↓
+Permissions
+ ↓
+Sandbox
+ ↓
+Tests
+ ↓
+Verification
+ ↓
+Response
+```
+
+Every permission decision, with the reason and who made it. No black box.
+
+---
+
+## 🧰 Skills
+
+Extend Vaan with local skills:
+
+```text
+.vaan/
+└── skills/
+    ├── code-review/
+    │   └── SKILL.md
+    └── deploy/
+        └── SKILL.md
+```
+
+Teach Vaan how to perform specialized workflows without changing the core runtime. Only the first
+line of each skill costs tokens; the full file is read when it actually applies.
+
+Skills are instruction, not permission — nothing a `SKILL.md` says can widen what the agent may do.
+
+---
+
+## 💻 CLI
+
+```bash
+vaan                  # ☁️ Start Vaan
+vaan init             # 🚀 Initialize
+vaan memory           # 🧠 Memory
+vaan schedule         # ⏰ Scheduling
+vaan trace            # 👀 Traces
+vaan doctor           # 🩺 Diagnostics
+vaan eval             # 🧪 Evaluations
+```
+
+Inside Vaan:
+
+```text
+/model       🤖 Change model
+/new         🆕 New conversation
+/memory      🧠 Memory
+/forget      🗑️ Forget
+/inbox       📥 Scheduled results
+/status      📊 Status
+/trace       👀 This request, in full
+/settings    ⚙️ Settings
+/help        ❓ Help
+/exit        👋 Exit
+```
+
+---
+
+## 🏗️ Architecture
+
+```text
+☁️ Vaan CLI
+     │
+     ▼
+🧠 Agent Runtime
+ ├── 🤖 Model
+ ├── 🧠 Memory
+ ├── 🔧 Tools
+ ├── 🔐 Permissions
+ └── 👀 Observability
+          │
+          ▼
+    📦 Coding Sandbox
+          │
+          ▼
+        ✓ Result
+```
+
+```text
+src/agent.ts         the loop — read this first
+src/index.ts         the runtime, where policy, gate and trace are built
+src/permissions/     capability classification; a floor no config can widen
+src/sandbox/         filesystem, process and network boundaries
+src/observability/   a Request ID and a full trace for every request
+src/providers/       Anthropic, OpenAI, Google, Ollama, custom endpoints
+src/memory/          SQLite with FTS5, two tiers
+src/eval/            suites for trajectory, security, sandbox, reliability
+```
+
+The model is replaceable. The runtime, permissions, memory, sandbox, traces and evals are not tied
+to any provider.
+
+Contributing: [CONTRIBUTING.md](CONTRIBUTING.md). Security reports: [SECURITY.md](SECURITY.md).
+
+---
+
+## 📜 License
+
+Apache License 2.0
+
+---
+
+**☁️ Vaan** — *Think. Remember. Act. Observe.*