diff --git a/README.md b/README.md index 955831b1..2635fe29 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,101 @@

- 1loop — Your project. Your model. One loop. + 1loop

- Download - CI - License: MPL-2.0 - Support on Ko-fi + Download + CI + License: MPL-2.0 + Ko-fi

- A coding agent you run on your own machine, with the models you choose.
- Desktop · Headless server · Android -

- -

- Install · - Guide · - Server · + Install  ·  + Guide  ·  + Server  ·  Build

---- - -1loop works in a project folder: it reads and edits files, runs commands, -browses the web and keeps a task list, while you watch and approve. The same -agent runs on the desktop, on a server and on your phone, and the phone can -drive the others from anywhere on your network. - - - - - - - - - - -
-

🧠 Your models

- ChatGPT (with your account), Claude Code, Antigravity CLI, OpenRouter, - vLLM and any OpenAI-compatible API. Several accounts at once, and switch - mid-conversation. - 		-

🛠️ A real workspace

- Files, shell, terminals, a browser it can use, Git changes and - background tasks, in a side panel next to the chat. Skills, plugins and - MCP servers too. -
-

🛡️ You stay in control

- Approve each action, let Auto mode review the risky ones in a sandbox, - or go YOLO. Your drafts survive crashes, and your data stays on your - machine. - 		-

📱 Everywhere

- Pair your phone with a QR code, run the agent on the phone itself, work - on SSH machines, and copy projects and their chats between devices. -
- -## 📦 Install - -Grab the latest version from the **[release page](https://feur-inc.github.io/1loop/)**; -the [install guide](docs/INSTALL.md) has every step. - -| Platform | Download | -|---|---| -| 🐧 Linux (x86-64) | `.tar.gz`, `.deb`, AppImage, [Flatpak, Nix](docs/INSTALL.md#linux-desktop-x86-64) | -| 🪟 Windows 10 1809+ (x64) | `.zip` | -| 🤖 Android 8+ | `.apk` | -| 🖥️ Server (Linux, Windows) | [headless server](docs/SERVER.md) | - -> [!WARNING] -> **Android may call 1loop harmful.** It's installed from outside the Play -> Store and runs shell commands, so Play Protect may warn you. Choose -> **Install anyway**, and only install APKs from the release page: their -> updates are signed and checked by the app. - -## 🚀 Getting started - -1. **Open a project:** `./1loop -workspace ~/my-project`, or add folders from the sidebar. -2. **Connect a model** in **Settings → Connections** ([details](docs/USAGE.md#getting-started)). -3. **Ask.** The agent works in the folder; its tool calls, diffs and tasks appear as it goes. -4. **Pair your phone** (optional): **Settings → Phone remote → Pair a phone**, then scan the QR code in the app. - -Then read the **[guide](docs/USAGE.md)** for approval modes, the side panel, -extensions, SSH machines, the phone app and shortcuts. - -## 📚 Documentation - -| Page | What's in it | -|---|---| -| [Install](docs/INSTALL.md) | every platform and package, sign-ins, where 1loop keeps its data | -| [Guide](docs/USAGE.md) | using 1loop, updates, security and privacy | -| [Server](docs/SERVER.md) | running 1loop headless and pairing devices to it | -| [Build](docs/BUILD.md) | building from source, the CI, publishing a release | - -## 🤝 Contributing - -Pull requests target `dev`, cite the issue they fix, and show before/after -screenshots for visible changes; see the +1loop is a coding agent that runs on your own machine, with the models you +pick. Point it at a project folder and it reads and edits files, runs +commands, browses the web and keeps a task list, asking for your approval as +it goes. + +It runs on the desktop, as a headless server and on Android, and the phone can +drive the other two over your network. + +## Features + +- **Any model.** ChatGPT (with your own account), Claude Code, Antigravity CLI, + OpenRouter, vLLM, or any OpenAI-compatible API. Use several accounts and + switch mid-conversation. +- **A real workspace.** Files, shell, terminals, a browser the agent can drive, + Git changes and background tasks, in a side panel next to the chat. Supports + skills, plugins and MCP servers. +- **Approval modes.** Approve every action, let Auto mode check risky ones in a + sandbox, or turn approvals off. Drafts survive crashes and nothing leaves + your machine. +- **Phone and remote hosts.** Pair a phone with a QR code, run the agent on the + phone itself, work on machines over SSH, and move projects and their chats + between devices. + +## Install + +Download the latest build from the [release page](https://feur-inc.github.io/1loop/). +Full instructions are in the [install guide](docs/INSTALL.md). + +| Platform | Packages | +| ------------------------ | ------------------------------------------------------------------------------------- | +| Linux x86-64 | `.tar.gz`, `.deb`, AppImage, [Flatpak, Nix](docs/INSTALL.md#linux-desktop-x86-64) | +| Windows 10 1809+ x64 | `.zip` | +| Android 8+ | `.apk` | +| Server (Linux, Windows) | [Headless server](docs/SERVER.md) | + +> [!NOTE] +> Play Protect may flag the Android app, since it's installed outside the Play +> Store and runs shell commands. Tap **Install anyway**, and only use APKs from +> the release page: the app verifies the signature of every update. + +## Quick start + +```sh +./1loop -workspace ~/my-project +``` + +1. Open a project, either with the command above or from the sidebar. +2. Connect a model in **Settings → Connections** ([details](docs/USAGE.md#getting-started)). +3. Ask for something. Tool calls, diffs and tasks show up as the agent works. +4. Optionally, pair your phone from **Settings → Phone remote → Pair a phone** + and scan the QR code in the app. + +The [guide](docs/USAGE.md) covers approval modes, the side panel, extensions, +SSH machines, the phone app and keyboard shortcuts. + +## Documentation + +| Page | Contents | +| -------------------------- | ------------------------------------------------------------ | +| [Install](docs/INSTALL.md) | Platforms, packages, sign-ins, where 1loop stores its data | +| [Guide](docs/USAGE.md) | Day-to-day use, updates, security and privacy | +| [Server](docs/SERVER.md) | Running headless and pairing devices | +| [Build](docs/BUILD.md) | Building from source, CI, publishing a release | + +## Contributing + +Open pull requests against `dev`, link the issue they fix, and include +before/after screenshots for UI changes. See the [pull request template](.github/pull_request_template.md). -## 💜 Support +## Support + +1loop is free. If it saves you time, you can support development on +[Ko-fi](https://ko-fi.com/tpm28). -1loop is free, and made for free. If it's useful to you, a donation on -**[Ko-fi](https://ko-fi.com/tpm28)** is really appreciated, even $1. Thank you! +## License -## 📄 License +Copyright © 2026 the 1loop contributors. Licensed under the +[Mozilla Public License 2.0](LICENSE). -Copyright (c) 2026 The 1loop contributors. 1loop is licensed under the -[Mozilla Public License 2.0](LICENSE). Bundled third-party code keeps its own -license, for example `third_party/fyne` (BSD-3-Clause) and the tools the -Android app ships, listed in `android/app/src/main/assets/local/licenses/`. +Bundled third-party code keeps its own license, for example `third_party/fyne` +(BSD-3-Clause) and the tools shipped with the Android app, listed in +`android/app/src/main/assets/local/licenses/`.