roadmodel 0.0.0__tar.gz

roadmodel-0.0.0/.gitignore

@@ -0,0 +1,40 @@
+# Environment + virtualenv
+.env
+.venv/
+
+# Editor / OS
+.vscode/
+**/.DS_Store
+
+# Python build artifacts
+__pycache__/
+*.pyc
+.pytest_cache/
+build/
+dist/
+*.egg-info/
+
+# Bundled docs copied from docs/ by hatch_build.py at build time.
+# This directory is build output; committing it would create a second
+# source of truth alongside docs/.
+/src/roadmodel/data/
+
+# Update run artifacts (transient outputs of update_models.py)
+update/.last-summary.txt
+update/.last-warnings.txt
+update/.cache/
+
+# Test fixtures (regenerated from update/build_fixture.py; never committed)
+tests/fixtures/*.json
+
+# Local user-specific selector config (real subscription values, API-key state).
+# The committed template is docs/user-context.example.md — copy it to
+# docs/user-context.md and fill in your values.
+/docs/user-context.md
+
+# NOTE: /private/ (local-only planning docs) is excluded via .git/info/exclude
+# rather than .gitignore so editor tooling (Cursor / VSCode @-pickers,
+# fuzzy-find) still indexes the files locally while git continues to ignore
+# them. The directory has already been scrubbed from history (commit 1b60bfb)
+# and exists only on the maintainer's machine, so the per-clone exclude is
+# sufficient.

roadmodel-0.0.0/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.

roadmodel-0.0.0/NOTICE

@@ -0,0 +1,16 @@
+roadmodel
+Copyright 2026 Nathan Ramos
+
+Third-party data attributions
+
+  * Artificial Analysis — benchmark index data and related factual
+    benchmark numbers cited in docs/model-selector.txt under fair use
+    as factual benchmark numbers.
+
+  * Cursor — pricing tier and list-price data cited in
+    docs/model-tier-cost-scale.md as factual list prices from Cursor's
+    published pricing materials.
+
+Third-party Python dependencies
+
+  see pyproject.toml [project] dependencies and PyPI for upstream licenses.

roadmodel-0.0.0/PKG-INFO

@@ -0,0 +1,409 @@
+Metadata-Version: 2.4
+Name: roadmodel
+Version: 0.0.0
+Summary: BYO-key CLI that recommends the right AI model, platform, and settings for a prompt.
+Project-URL: Homepage, https://roadmodel.ai
+Project-URL: Repository, https://github.com/nathanramoscfa/roadmodel
+Project-URL: Issues, https://github.com/nathanramoscfa/roadmodel/issues
+Author-email: Nathan Ramos <nathan.ramos.github@gmail.com>
+License: 
+                                         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.
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ai,anthropic,cli,gemini,llm,model-selection,openai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: anthropic>=0.97.0
+Requires-Dist: click>=8.3.3
+Requires-Dist: google-genai>=1.74.0
+Requires-Dist: openai>=2.33.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: twine>=5.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# roadmodel
+
+A BYO-key command-line tool that recommends **which AI model on which
+platform with which settings** for a given prompt. Point it at a task
+description, and it returns a six-field block — `MODEL / PLATFORM /
+MAX MODE / THINKING / CONVERSATION / RATIONALE` — grounded in a
+bundled benchmark and pricing catalog (Cursor pricing, Artificial
+Analysis, LiveCodeBench, τ²-bench, SWE-bench, MMMU, LMArena) and
+filtered against your own subscriptions and API keys. Built for
+developers who use several AI subscriptions (Claude Code, Cursor,
+Codex / ChatGPT, raw provider APIs) and want a deterministic answer
+to "what should I use for this?" instead of guessing.
+
+[![PyPI version](https://img.shields.io/pypi/v/roadmodel.svg)](https://pypi.org/project/roadmodel/)
+[![Python versions](https://img.shields.io/pypi/pyversions/roadmodel.svg)](https://pypi.org/project/roadmodel/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![CI](https://github.com/nathanramoscfa/roadmodel/actions/workflows/tests.yml/badge.svg)](https://github.com/nathanramoscfa/roadmodel/actions/workflows/tests.yml)
+
+## Install
+
+```sh
+pip install roadmodel
+```
+
+Python 3.11 or newer.
+
+## Quickstart
+
+Three steps from a fresh install to a parsed recommendation block.
+
+**1. Export an API key for any one of the three providers.** Anthropic
+shown here; OpenAI and Google work the same way — see
+[docs/byo-key-setup.md](docs/byo-key-setup.md) for the full guide.
+
+```sh
+export ANTHROPIC_API_KEY=sk-ant-...
+```
+
+**2. Run `roadmodel recommend` once to bootstrap your user-context
+file.** On the first invocation, the CLI writes a copy of the bundled
+template to `~/.config/roadmodel/user-context.md` (or
+`$XDG_CONFIG_HOME/roadmodel/user-context.md` when `XDG_CONFIG_HOME` is
+set), prints a one-line stderr notice telling you what it did, and
+exits without calling the provider. Open the file and replace the
+`$XXX` and `Yes/No` placeholders with your actual subscription
+amounts and API-key state. The full field-by-field walk-through lives
+in [docs/user-context-setup.md](docs/user-context-setup.md).
+
+```sh
+roadmodel recommend "Refactor auth middleware across 12 files"
+# stderr: Created /home/you/.config/roadmodel/user-context.md from
+#         bundled template. Edit it with your real subscription
+#         state, then re-run.
+
+$EDITOR ~/.config/roadmodel/user-context.md
+```
+
+**3. Re-run.** With the user-context filled in, the same command
+calls your chosen provider and prints a parsed six-field block:
+
+```sh
+roadmodel recommend "Refactor auth middleware across 12 files"
+```
+
+```
+MODEL: claude-opus-4-7
+PLATFORM: Claude Code
+MAX MODE: On
+THINKING: High
+CONVERSATION: New
+RATIONALE: Coding PRIMARY with cross-file scope and High complexity.
+Opus 4.7 is S-tier on coding-agent benchmarks and the only model in
+the catalog rated S for long-context recall. PLATFORM Claude Code
+is funded by claude.ai Max ($0 marginal); THINKING High per the
+selection-algorithm rule for High-complexity coding.
+```
+
+Pass `--json` to emit the same fields as machine-readable JSON, or
+`--file PATH` to read the prompt from disk.
+
+## BYO-key setup
+
+roadmodel ships with no provider key built in — it calls
+**your** Anthropic / OpenAI / Google account on every recommendation
+and charges your account. Set any one of the three environment
+variables and the CLI auto-selects that provider:
+
+| Provider  | Env var             |
+| --------- | ------------------- |
+| Anthropic | `ANTHROPIC_API_KEY` |
+| OpenAI    | `OPENAI_API_KEY`    |
+| Google    | `GOOGLE_API_KEY`    |
+
+The full guide — generating keys in each provider's console, storing
+them in a shell profile or `~/.config/roadmodel/config.toml`,
+precedence rules, and verifying with a smoke call — is
+[docs/byo-key-setup.md](docs/byo-key-setup.md).
+
+## User context setup
+
+roadmodel reads a per-user Markdown file describing your active
+subscriptions, API keys, platform preference order, and budget
+posture so the `<access-selection>` step can pick a **platform** and
+**thinking level** alongside the model. The resolved default path is
+`~/.config/roadmodel/user-context.md` (or
+`$XDG_CONFIG_HOME/roadmodel/user-context.md` when `XDG_CONFIG_HOME`
+is set); override it for a single run with `--user-context PATH` or
+for a whole shell with `ROADMODEL_USER_CONTEXT=PATH`. The full
+walk-through — first-run bootstrap, full precedence chain,
+field-by-field schema, when to update — is
+[docs/user-context-setup.md](docs/user-context-setup.md).
+
+## Subcommands
+
+| Command                          | What it does                                                                       |
+| -------------------------------- | ---------------------------------------------------------------------------------- |
+| `roadmodel recommend PROMPT`     | Recommend a six-field block for the given prompt.                                  |
+| `roadmodel recommend --file P`   | Same, but read the prompt text from file `P`.                                      |
+| `roadmodel recommend --json`     | Emit the parsed six fields as JSON instead of the labeled text block.              |
+| `roadmodel recommend --provider` | Override which provider answers (`anthropic` / `openai` / `google`).               |
+| `roadmodel recommend --model`    | Override the specific model ID on the chosen provider.                             |
+| `roadmodel recommend --user-context PATH` | Override the user-context.md location for this invocation.                |
+| `roadmodel catalog show`         | Print the bundled `model-selector.txt` (use `--doc tier-cost-scale` for the price doc). |
+| `roadmodel catalog path`         | Print the on-disk path of the bundled catalog document (same `--doc` flag).        |
+| `roadmodel context show`         | Print the resolved `user-context.md` file.                                         |
+| `roadmodel context path`         | Print the resolved `user-context.md` path (or the bootstrap target if missing).    |
+| `roadmodel context init`         | Bootstrap `user-context.md` from the bundled template (`--force` to overwrite).    |
+| `roadmodel version`              | Print the installed version.                                                       |
+
+## How it works
+
+The CLI ships three documents as package data:
+[`model-selector.txt`](docs/model-selector.txt) (the selection
+algorithm and the per-model access-methods catalog),
+[`model-tier-cost-scale.md`](docs/model-tier-cost-scale.md) (per-token
+prices and tier ratings), and
+[`user-context.example.md`](docs/user-context.example.md) (the
+user-state template). At recommendation time, `roadmodel recommend`
+reads your filled-in `user-context.md` from disk, concatenates the
+three docs into a single system prompt, and calls the provider you
+configured. The provider returns a `MODEL / PLATFORM / MAX MODE /
+THINKING / CONVERSATION / RATIONALE` block following the
+`<output-format>` specification inside `model-selector.txt`. `MODEL`
+is chosen by `<selection-algorithm>` against your prompt's task
+category and complexity; `PLATFORM` and `THINKING` are filled by the
+`<access-selection>` step, which depends on the subscriptions and
+API-key state declared in your `user-context.md`.
+
+## Project status
+
+roadmodel is in **Phase 1** of the public
+[ROADMAP.md](ROADMAP.md) — the open-source CLI release. Phase 2 adds
+an MCP server alongside the CLI; later phases add a hosted SaaS at
+`roadmodel.ai`. The project was previously named `model-selector`
+and was renamed to `roadmodel` ahead of the public release; the
+canonical bundled-doc filename `model-selector.txt` is preserved so
+existing references in other projects keep working. Until v1.0.0,
+expect breaking changes to the CLI surface as Phase 2 lands.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for branch naming, pull
+request scope, the catalog-edit process, and the
+[Code of Conduct](CODE_OF_CONDUCT.md) that applies in community
+spaces. Report security issues privately per [SECURITY.md](SECURITY.md).
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE). Bundled
+third-party attributions are listed in [NOTICE](NOTICE).