Skip to content

Commit 34c567a

Browse files
authored
v1.1 commit
1 parent 4ac5972 commit 34c567a

2 files changed

Lines changed: 134 additions & 0 deletions

File tree

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Orbit
2+
3+
Orbit is a local-first AI agent that lives on your machine and helps you get real work done across files, tools, and applications—while keeping you in full control of your data and execution.
4+
5+
It is designed to act less like a chatbot and more like a system-level assistant that can plan, reason, and safely execute tasks inside your environment.
6+
7+
## What Orbit is
8+
9+
Orbit is an extensible agent runtime for macOS that connects AI reasoning with real system capabilities.
10+
11+
You describe intent in natural language. Orbit translates that into structured plans, executes them through tools, and keeps every step transparent and recoverable.
12+
13+
## Core principles
14+
15+
- **Local-first by default** – your data and execution stay on your machine
16+
- **Tool-based intelligence** – capabilities come from tools, not hidden prompts
17+
- **Plan before execution** – complex tasks are decomposed into structured plans
18+
- **Fully observable** – every action is traceable and recoverable
19+
- **Extensible by design** – new tools and plugins expand what Orbit can do
20+
21+
## What it can do
22+
23+
Orbit can:
24+
- Execute multi-step workflows using a planning system
25+
- Interact with your filesystem and development environment
26+
- Work with Git repositories through structured tools
27+
- Run tasks safely with approval controls for sensitive operations
28+
- Maintain workspace-scoped context and memory
29+
- Integrate external capabilities through MCP-compatible tools
30+
31+
## Architecture at a glance
32+
33+
Orbit is built around a deterministic agent loop:
34+
35+
1. User intent is received
36+
2. A structured plan is generated (or fallback reasoning is used)
37+
3. Tasks are executed through tools in a controlled runtime
38+
4. State is checkpointed after each step
39+
5. Results are streamed back to the interface
40+
41+
Everything is event-driven, observable, and recoverable.
42+
43+
## Current status
44+
45+
Orbit is under active development.
46+
47+
- Core agent runtime: implemented
48+
- Planning system: implemented
49+
- MCP transport layer: implemented
50+
- Workspace system: implemented
51+
- Git tooling: implemented
52+
- UI layer: in progress
53+
54+
This is an early but functional platform, not a finished product.
55+
56+
## Why Orbit exists
57+
58+
Most AI tools today are either:
59+
- chat interfaces with no real system access, or
60+
- closed platforms where you lose control over execution and data
61+
62+
Orbit is an attempt to bridge that gap—bringing structured AI reasoning into a local, transparent, and extensible runtime that developers can actually build on.
63+
64+
## License
65+
66+
AGPL-3.0 — see LICENSE file for details.
67+
68+
## Contributing
69+
70+
This project is early-stage and evolving quickly. Contributions, ideas, and feedback are welcome once the initial architecture stabilizes.
71+
72+
For now, the best way to help is to build with it, break it, and see where it fails.
73+
74+
## Status
75+
76+
Orbit is actively evolving through a multi-phase build toward a full local-first agent platform.

SECURITY.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Security Policy
2+
3+
Orbit is a local-first AI agent runtime that can execute system-level tools on macOS. Because of this, security issues are taken seriously.
4+
5+
Supported Versions
6+
7+
Security fixes are applied to the latest stable release only.
8+
9+
Reporting a Vulnerability
10+
11+
If you discover a security vulnerability, please do not open a public issue.
12+
13+
Instead, report it privately via GitHub Security Advisories or contact the maintainer directly.
14+
15+
Please include:
16+
17+
* description of the issue
18+
* steps to reproduce
19+
* potential impact
20+
* any suggested mitigation (if available)
21+
22+
Scope
23+
24+
The following areas are in scope:
25+
26+
* MCP server transport layer
27+
* tool execution system (especially system commands)
28+
* plugin system (future)
29+
* memory and workspace data isolation
30+
* API endpoints (future HTTP layer)
31+
32+
Out of scope:
33+
34+
* misuse of tools when explicitly approved by the user
35+
* issues in third-party dependencies unless exploitable through Orbit directly
36+
37+
Security Model
38+
39+
Orbit assumes a user-controlled trust model:
40+
41+
* tools must explicitly request permission for sensitive actions
42+
* MCP connections require local socket or explicit transport setup
43+
* plugins run in isolated subprocesses (when enabled)
44+
* no remote execution is allowed by default
45+
46+
Users are responsible for:
47+
48+
* approving tool execution
49+
* managing plugin installations
50+
* controlling API exposure if enabled
51+
52+
Disclosure Policy
53+
54+
We aim to:
55+
56+
* acknowledge reports within 72 hours
57+
* provide a fix or mitigation plan as soon as feasible
58+
* coordinate disclosure once a patch is available

0 commit comments

Comments
 (0)