82 lines · 4 KBtext/plain; charset=utf-8
Onset: version control where nobody waits and nothing gets lost. The on command, its core and onset-server.
| 6 | - **Nothing is lost.** Work saves itself, `on undo` takes back what you did (a land included), and a change follows you to another machine. |
| 7 | - **Private where you need it.** A folder can be visible to only some people, `.env` files stay yours, and likely secrets are stopped before they land. |
| 8 |
| 9 | It has its own model and protocol. Git is a bridge: `on import` brings a repository's history in, and every hosted project is also a git repository that git, CI and GitHub mirrors keep using. |
| 10 |
| 11 | ## Install |
| 12 |
| 13 | ```sh |
| 14 | curl -fsSL https://downloads.coline.dev/onset/install.sh | sh |
| 15 | ``` |
| 16 |
| 17 | On Windows, in PowerShell: |
| 18 |
| 19 | ```powershell |
| 20 | irm https://downloads.coline.dev/onset/install.ps1 | iex |
| 21 | ``` |
| 22 |
| 23 | Or with Homebrew, from Coline's tap on Upstream: |
| 24 |
| 25 | ```sh |
| 26 | brew tap coline/tap https://git.coline.app/coline/homebrew-tap.git |
| 27 | brew install coline/tap/onset |
| 28 | ``` |
| 29 |
| 30 | Or with npm (Node 18 or later; every run goes through Node, so the others start a little faster): |
| 31 |
| 32 | ```sh |
| 33 | npm install -g @colineapp/onset |
| 34 | ``` |
| 35 |
| 36 | macOS (Apple silicon and Intel), Linux (x64 and arm64) and Windows (x64 and arm64). On Windows, files keep being executable or links in Onset when edited there, as in git; links Windows won't make (without Developer Mode) are files holding their target. Or build it: `cargo build --release -p onset-cli` in this folder (Rust 1.90 or later). |
| 37 |
| 38 | Shell completions: `on completions zsh > ~/.zfunc/_on` (or bash, fish, powershell, elvish). |
| 39 |
| 40 | Onset was called vcs before it had its name. Installing it replaces the `vcs` command, and `on` picks up where it left off: sign-ins, projects, workspaces (their `.vcs` folders become `.onset`), `vcs.toml` files and `VCS_*` settings all keep working. |
| 41 |
| 42 | ## Start |
| 43 |
| 44 | ```sh |
| 45 | on login # signs in to upstream.codes in your browser |
| 46 | on get upstream.codes/acme/shop # a workspace on a new change |
| 47 | # ...edit files... |
| 48 | on land -m "Fix the login redirect" # merged into main on the server |
| 49 | ``` |
| 50 |
| 51 | A project of your own, with no server: `on init`, then `on publish upstream.codes/you/name` when you want to share it. A git repository: `on import <git url> --to upstream.codes/you/name`. |
| 52 |
| 53 | `on guide` prints [GUIDE.md](GUIDE.md), the instructions for coding agents. [docs/git-teams.md](docs/git-teams.md) is for teams on git: trying Onset, using both, moving over. [docs/safety.md](docs/safety.md) covers what keeps code safe. [SPEC.md](SPEC.md) describes every command, how landing works, access, the git bridge and the protocol. |
| 54 |
| 55 | ## Hosting |
| 56 |
| 57 | - **Upstream** hosts projects at upstream.codes (the service is in `apps/onset` of the Coline repository). Agents without a workspace can use its HTTP API or MCP at `https://onset.coline.dev/mcp`. |
| 58 | - **Your own server:** `onset-server` is one binary with SQLite and a folder of objects. |
| 59 |
| 60 | ```sh |
| 61 | onset-server user add alice --name Alice --email alice@example.com --data ./data # prints a token |
| 62 | onset-server serve --data ./data --listen 0.0.0.0:8790 |
| 63 | on login your.host:8790 --token <token> |
| 64 | ``` |
| 65 |
| 66 | Put it behind HTTPS (`on` talks plain HTTP only to localhost, or with `ONSET_INSECURE=1`). For a git copy (GitHub, GitLab, your own git server), run `on git mirror <git url>` next to it. |
| 67 | - **GitHub stays where it is:** `on git mirror https://github.com/acme/shop` keeps GitHub's `main` as the project's main, both ways: versions go out as commits, and pull requests merged there come in as versions. |
| 68 |
| 69 | ## Layout |
| 70 |
| 71 | | Folder | What | License | |
| 72 | |---|---|---| |
| 73 | | `core` | The model: objects, trees, merges, private paths, secrets. No I/O. | Apache-2.0 | |
| 74 | | `cli` | The `on` command. | Apache-2.0 | |
| 75 | | `server` | `onset-server`, for self-hosting. | AGPL-3.0 | |
| 76 | | `wasm` | The core for Upstream's host (Cloudflare Workers). | Apache-2.0 | |
| 77 | | `tests` | End-to-end suites: `local.sh`, `hosted.sh` (`ONSET_TARGET=worker` for Upstream's host), `git.sh`, `perf.sh`, and the agent run in `tests/agent`. | | |
| 78 | | `install` | The installers, the release manifest and Homebrew formula scripts, and `tap.sh` (puts a release in the Homebrew tap). | | |
| 79 | | `npm` | The `@colineapp/onset` npm package and `pack.sh`, which packs it for a release. | | |
| 80 |
| 81 | Licenses: [LICENSE-APACHE](LICENSE-APACHE), and [server/LICENSE](server/LICENSE) for the server. |
| 82 |