diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..bf70b445 --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + 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 the 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 the 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 any 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 + + Copyright 2025 OpenRouter + + 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. diff --git a/README.md b/README.md index 08321ad6..518ae840 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Spawn -Launch any agent on any cloud, powered by [OpenRouter](https://openrouter.ai). +Launch any AI coding agent on any cloud with a single command. All models powered by [OpenRouter](https://openrouter.ai). + +**13 agents. 18 clouds. 234 combinations. Zero config.** ## Install @@ -21,9 +23,9 @@ spawn list # Show the full matrix ```bash spawn # Interactive picker spawn claude sprite # Claude Code on Sprite -spawn aider hetzner # Aider on Hetzner Cloud -spawn claude sprite --prompt "Fix bugs" # Execute with prompt (non-interactive) -spawn aider sprite -p "Add tests" # Short form of --prompt +spawn aider hetzner # Aider on Hetzner +spawn claude sprite --prompt "Fix bugs" # Non-interactive with prompt +spawn aider sprite -p "Add tests" # Short form spawn claude # Show clouds available for Claude ``` @@ -33,19 +35,17 @@ spawn claude # Show clouds available for Claude |---------|-------------| | `spawn` | Interactive agent + cloud picker | | `spawn ` | Launch agent on cloud directly | -| `spawn --prompt "text"` | Execute agent with prompt (non-interactive) | -| `spawn --prompt-file file.txt` | Execute agent with prompt from file | +| `spawn -p "text"` | Non-interactive with prompt | +| `spawn --prompt-file f.txt` | Prompt from file | | `spawn ` | Show available clouds for an agent | | `spawn list` | Full agent x cloud matrix | | `spawn agents` | List all agents | | `spawn clouds` | List all cloud providers | -| `spawn improve` | Run improvement system | | `spawn update` | Check for CLI updates | -| `spawn version` | Show version | ### Without the CLI -Every combination also works as a one-liner: +Every combination works as a one-liner — no install required: ```bash bash <(curl -fsSL https://openrouter.ai/lab/spawn/{cloud}/{agent}.sh) @@ -56,11 +56,10 @@ bash <(curl -fsSL https://openrouter.ai/lab/spawn/{cloud}/{agent}.sh) Skip all prompts with environment variables: ```bash -OPENROUTER_API_KEY=sk-or-v1-xxxxx \ - spawn claude sprite +OPENROUTER_API_KEY=sk-or-v1-xxxxx spawn claude sprite ``` -Each cloud has its own env vars for auth — see the cloud's [README](sprite/README.md). +Each cloud has its own env vars for auth — see the cloud's README. ## Matrix @@ -80,6 +79,17 @@ Each cloud has its own env vars for auth — see the cloud's [README](sprite/REA | [**OpenCode**](https://github.com/opencode-ai/opencode) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**Plandex**](https://github.com/plandex-ai/plandex) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +### How it works + +Each cell in the matrix is a self-contained bash script that: + +1. Provisions a server on the cloud provider +2. Installs the coding agent +3. Injects your [OpenRouter](https://openrouter.ai) API key so every agent uses the same billing +4. Drops you into an interactive session + +Scripts work standalone (`bash <(curl ...)`) or through the CLI. + ## Development ```bash @@ -87,3 +97,30 @@ git clone https://github.com/OpenRouterTeam/spawn.git cd spawn git config core.hooksPath .githooks ``` + +### Structure + +``` +{cloud}/lib/common.sh # Cloud provider primitives (provision, SSH, cleanup) +{cloud}/{agent}.sh # Agent deployment script +shared/common.sh # Shared utilities (OAuth, logging, SSH helpers) +cli/ # TypeScript CLI (bun) +manifest.json # Source of truth for the matrix +``` + +### Adding a new cloud + +1. Create `{cloud}/lib/common.sh` with provisioning primitives +2. Add to `manifest.json` +3. Implement agent scripts using the cloud's primitives +4. See [CLAUDE.md](CLAUDE.md) for full contributor guide + +### Adding a new agent + +1. Add to `manifest.json` +2. Implement on 1+ cloud by adapting an existing agent script +3. Must support OpenRouter via env var injection + +## License + +[Apache 2.0](LICENSE)