orcacompass 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

package/NOTICE

@@ -0,0 +1,51 @@
+OrcaCompass
+Copyright 2026 Vittorio Emanuel Deian
+
+OrcaCompass is licensed under the Apache License, Version 2.0.
+
+Bundled data attributions
+
+data/models-snapshot.json contains a trimmed snapshot of model metadata from
+Models.dev (https://models.dev), retrieved from https://models.dev/api.json.
+
+Models.dev is distributed under the MIT License:
+https://github.com/anomalyco/models.dev/blob/dev/LICENSE
+
+MIT License
+
+Copyright (c) 2025 models.dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+data/modelindex-snapshot.json contains a trimmed snapshot of capability scores
+and OpenRouter output prices from The Model Index (https://themodelindex.org),
+retrieved from https://themodelindex.org/data/models.json.
+The Model Index data is licensed under Creative Commons Attribution 4.0
+International (CC BY 4.0): https://creativecommons.org/licenses/by/4.0/.
+
+The snapshots retain selected fields and add a retrieval timestamp; these
+attributions do not change the terms applicable to the source data.
+
+Benchmark placement uses data from Artificial Analysis
+(https://artificialanalysis.ai) fetched at run time with the user's own
+Data API key. That data is licensed to the key's owner under the Artificial
+Analysis Data Platform Terms; it is cached on the user's machine only and no
+part of it is bundled with this package. Tier placements derived from it are
+OrcaCompass's own and are neither endorsed by nor the responsibility of
+Artificial Analysis. "Source: Artificial Analysis (artificialanalysis.ai)".

package/README.md

@@ -1,3 +1,171 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<div align="center">
+
+# OrcaCompass
+
+**Help your orchestrator pick the right model for every job.**
+
+<p>
+<img src="docs/assets/orca-comic-strip.jpg" width="100%" alt="Three-panel orca comic. 1: the pod trusts its leader to match each job to its best model. 2: the leader is unsure which model fits each job and how to share the load, thinking of Anthropic, OpenAI, and + more. 3: holding a glowing compass, the leader sends each worker along a route to Anthropic, OpenAI, or + more." />
+</p>
+
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Node.js: 20+](https://img.shields.io/badge/Node.js-%3E%3D20-339933?logo=nodedotjs&logoColor=white)](package.json)
+[![Platforms: Windows, macOS, Linux](https://img.shields.io/badge/platforms-Windows%20%7C%20macOS%20%7C%20Linux-64748b)](#install)
+
+[Install](#install) · [Quick start](#quick-start) · [User guide](docs/README.md) · [Commands](docs/commands.md) · [Troubleshooting](docs/troubleshooting.md) · [Contributing](CONTRIBUTING.md)
+
+</div>
+
+An [Orca](https://github.com/stablyai/orca) orchestrator that hands a job to a
+worker has to pick an agent, a model and a reasoning effort. On its own it
+cannot tell which of your installed models suits the job, or how much of each
+plan's usage is left before the limits reset. OrcaCompass makes that choice:
+the orchestrator rates how hard the job is, and OrcaCompass compares the
+installed Claude Code, Codex, Cursor, Grok Build, Antigravity and OpenCode
+routes using model metadata and current usage limits, explains its choice, and
+returns launch arguments. The orchestrator still launches the worker. It ships
+as an Agent Skill backed by a small TypeScript CLI.
+
+## How it works
+
+1. **The orchestrator rates the job** as one of four difficulty tiers.
+2. **OrcaCompass finds what you can actually use:** installed agent CLIs that
+   you have enabled in Orca and not switched off in OrcaCompass, their models,
+   and current usage from Orca.
+3. **It keeps only models that fit the tier,** then prefers the one with the
+   most headroom: the share of its usage window expected to be left unused at
+   reset. Nearly exhausted windows are skipped.
+4. **It returns a route** (agent, model, effort) with the reasons and ready-made
+   launch arguments.
+
+| Tier | What it means | Typical job | Default effort |
+| --- | --- | --- | --- |
+| `light` | Mechanical; a mistake is cheap and easy to see | Renames, config values, summaries, lookups | `low` |
+| `daily` | Ordinary engineering without a written plan | Features in a few files, reproducible bugs, tests | `medium` |
+| `advanced` | Needs a plan; mistakes are costly or subtle | Cross-cutting refactors, races, schema changes, security | `medium` |
+| `frontier` | The edge of what models can do | Novel algorithms, failures Advanced could not solve | `high` |
+
+## Install
+
+You need Node.js 20 or later (22.5 or later to read Orca's agent switches),
+the agent CLIs you want to route to installed and signed in, and Orca running
+for live usage data. Then:
+
+```sh
+npx orcacompass install --global
+```
+
+One command installs the CLI and the matching Skill for your user. Add
+`--agent <name>` to choose which agents receive the Skill, or `--yes` to accept
+the installer's defaults. For a project-local Skill instead, run it without
+`--global` in that project.
+
+Alternatively, build the current `main` from source with Node.js 24 and npm:
+
+```sh
+git clone https://github.com/manomilano/orca-compass.git
+cd orca-compass
+npm ci
+npm install -g .
+orcacompass install --skill-only --global
+```
+
+See [Getting started](docs/getting-started.md#install) for details. Keep Orca's
+own orchestration skill installed alongside it. To work on OrcaCompass itself,
+see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Quick start
+
+```sh
+orcacompass setup
+```
+
+`setup` asks three short questions in the terminal (which agents to use,
+optional favorite routes per tier, models never to use), then shows the
+result with an example route per tier and saves it once you confirm. Press
+Enter to keep any answer; running it again starts from your current settings.
+With the Skill installed you can also just ask your orchestrator to "set up
+OrcaCompass": it asks the same questions in chat (and offers to before your
+first route).
+
+Everything `setup` does is also a command of its own:
+
+```sh
+orcacompass status                        # agents, usage, and the pick for each tier
+orcacompass tiers                         # every model's tiers, with the numbers behind them
+orcacompass agents                        # which agents are used, and why not
+orcacompass agents disable grok           # never route to Grok Build
+orcacompass prefer daily codex            # Codex first for everyday jobs, unless it runs too hot
+orcacompass ban claude-haiku              # never route a Claude Haiku model
+orcacompass route --tier daily --json     # a route for an everyday job
+orcacompass route --tier advanced --agent claude --agent codex --demand high
+orcacompass route --tier frontier --no-downgrade --json   # never fall back to a lower tier
+```
+
+With the Skill installed, the orchestrator does this for you: it rates each
+job, calls `orcacompass route`, and launches the worker with the returned
+arguments:
+
+```sh
+orca orchestration worker-start --spec "<actual task>" --agent claude --model claude-opus-5-5 --effort medium
+```
+
+Only `status: "ok"` carries a route. Pass `launchArgs` as separate, properly
+quoted arguments together with your usual Orca worktree and lifecycle options.
+OrcaCompass never launches workers itself.
+
+For example, a routing decision can look like this (illustrative numbers):
+
+```text
+$ orcacompass route --tier advanced
+advanced → claude · claude-opus-5-5 · medium (high confidence)
+  claude claude-opus-5-5: weekly 40% used, 62% of window elapsed (headroom 34%) → on pace for 65% before reset in 2d
+```
+
+## User guide
+
+Start with [Getting started](docs/getting-started.md), or browse the
+[complete user guide](docs/README.md).
+
+| Learn about | Read |
+| --- | --- |
+| Every command, flag, exit code and JSON response | [Commands](docs/commands.md) |
+| Preferences, bans, paths and defaults | [Configuration](docs/configuration.md) |
+| How routes are ranked and how fallbacks work | [Tiers and routing](docs/tiers-and-routing.md) |
+| Reasoning demand and supported effort levels | [Effort](docs/effort.md) |
+| How the orchestrator routes, launches and verifies | [Skill workflow](docs/skill-workflow.md) |
+| Checking that a worker's agent accepted its model | [Verify and rejections](docs/verify-and-rejections.md) |
+| Supported agents and where their models come from | [Models and agents](docs/models-and-agents.md) |
+| What to do when an agent is not used or a route fails | [Troubleshooting](docs/troubleshooting.md) |
+| Planned work and known limitations | [Roadmap](docs/roadmap.md) |
+
+## Contributing
+
+Contributions are welcome, from a new model family to a whole agent adapter.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, tests and the PR checklist.
+Everyone taking part follows the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Security
+
+Report vulnerabilities privately through GitHub's
+[private vulnerability reporting](https://github.com/manomilano/orca-compass/security/advisories/new),
+not in a public issue. [SECURITY.md](SECURITY.md) says what to include and
+what is in scope.
+
+## License
+
+OrcaCompass is licensed under the [Apache License 2.0](LICENSE).
+Copyright 2026 Vittorio Emanuel Deian.
+
+The bundled `data/models-snapshot.json` contains trimmed metadata from
+[Models.dev](https://models.dev). Capability scores and prices in
+`data/modelindex-snapshot.json` are trimmed from
+[The Model Index](https://themodelindex.org), licensed under
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
+Benchmark placement reads [Artificial Analysis](https://artificialanalysis.ai)
+data with your own Data API key (`ARTIFICIAL_ANALYSIS_API_KEY`);
+nothing from it is bundled. See [NOTICE](NOTICE) for data attributions.
+
+Every model's tiers are computed once from all of these sources into a
+placement table in your cache, rebuilt every 5 hours or by `orcacompass
+refresh`. A route reads that table and your live Orca usage, nothing else.