codefreedom 0.1.0__tar.gz

codefreedom-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025 Nilay Parikh
+
+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.

codefreedom-0.1.0/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: codefreedom
+Version: 0.1.0
+Summary: CLI for running Claude Code through LiteLLM — local AI inference, anywhere
+Author-email: Nilay Parikh <nilay.parikh@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/nilayparikh/codefreedom
+Project-URL: Repository, https://github.com/nilayparikh/codefreedom
+Keywords: claude-code,litellm,ai,llm,local-inference
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: types-PyYAML
+Provides-Extra: litellm
+Requires-Dist: litellm[proxy]>=1.50; extra == "litellm"
+Requires-Dist: prometheus-client>=0.20; extra == "litellm"
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Provides-Extra: all
+Requires-Dist: codefreedom[dev,litellm]; extra == "all"
+Dynamic: license-file
+
+# CodeFreedom
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](pyproject.toml)
+[![Integration Tests](https://github.com/nilayparikh/codefreedom/actions/workflows/integration-test.yml/badge.svg)](https://github.com/nilayparikh/codefreedom/actions/workflows/integration-test.yml)
+[![PyPI](https://img.shields.io/pypi/v/codefreedom.svg)](https://pypi.org/project/codefreedom/)
+
+**Claude Code launcher and LiteLLM proxy — AI-augmented coding, anywhere.**
+
+CodeFreedom gives you a single CLI tool (`codefreedom` / `cf`) that:
+
+1. **Runs Claude Code** natively or inside a Docker container with GPU passthrough, profile-based model routing, and multi-session support.
+2. **Manages a LiteLLM proxy** — stateless by default, with optional PostgreSQL for the Admin UI, spend tracking, and key management.
+3. **Routes to any provider** — local self-hosted models, cloud APIs (DeepSeek, Azure, NVIDIA, OpenCode Zen), or any OpenAI/Anthropic-compatible endpoint.
+
+## Why CodeFreedom?
+
+CodeFreedom extracts the **LiteLLM proxy** and **Claude Code launcher** from the [`.init`](https://github.com/nilayparikh/spark-init) stack into a standalone, portable tool. Where `.init` is a full Docker Compose stack with PostgreSQL, observability, and llama.cpp backends, CodeFreedom is the lightweight companion you can install anywhere and use with any LiteLLM-compatible backend.
+
+| Feature              | `.init`                 | `codefreedom`                             |
+| -------------------- | ----------------------- | ----------------------------------------- |
+| LiteLLM proxy        | ✅ (part of full stack) | ✅ (standalone, stateless)                |
+| Claude Code launcher | ✅ (`claude-code.py`)   | ✅ (`codefreedom claude`)                 |
+| PostgreSQL           | ✅ (bundled)            | ✅ (optional — connect external Postgres) |
+| llama.cpp backends   | ✅ (bundled)            | ❌ (use .init for local inference)        |
+| Observability        | ✅ (Grafana/Mimir/Loki) | ❌ (use .init)                            |
+| pip installable      | ❌                      | ✅                                        |
+
+## Quick Start
+
+### Installation
+
+**From PyPI (recommended):**
+
+```bash
+pip install codefreedom
+```
+
+**From source:**
+
+```bash
+git clone https://github.com/nilayparikh/codefreedom.git
+cd codefreedom
+pip install -e .
+```
+
+Now you can run `codefreedom` or `cf` from anywhere:
+
+```bash
+codefreedom --help
+cf --help
+```
+
+### Initialize
+
+```bash
+# Creates ~/.codefreedom/ with default profiles and proxy configs
+codefreedom --init
+
+# Overwrite existing files
+codefreedom --init --force
+```
+
+This creates:
+
+```
+~/.codefreedom/
+├── profiles/
+│   ├── claude-code.json                  # Profile definitions
+│   └── claude-code-profiles.schema.json  # JSON Schema for validation
+└── proxy/
+    ├── docker-compose.yml                # Docker Compose for LiteLLM
+    └── config/
+        ├── config.yaml                   # LiteLLM proxy configuration
+        └── providers/                    # Provider-specific configs
+            ├── deepseek.yaml
+            ├── azure-foundry.yaml
+            ├── nvidia.yaml
+            ├── local.yaml
+            ├── openai-compatible.yaml
+            ├── anthropic-compatible.yaml
+            └── opencode-zen.yaml
+```
+
+### 1. Start the LiteLLM Proxy
+
+```bash
+# Edit ~/.codefreedom/proxy/config/config.yaml to configure providers
+# Set LITELLM_MASTER_KEY in your environment
+
+# Start via Docker Compose
+codefreedom proxy --up --docker
+
+# Or start natively (requires: pip install codefreedom[litellm])
+codefreedom proxy --up
+
+# Validate config
+codefreedom proxy --validate
+```
+
+The proxy starts stateless — no database, no Prisma, just model routing.
+See [LiteLLM Proxy → Database](docs/litellm.md#database-backends) for PostgreSQL setup.
+
+### 2. Launch Claude Code
+
+```bash
+# Default: native mode with Flash model
+codefreedom claude
+
+# Short alias
+cf cc
+
+# Pick a model profile
+codefreedom claude --profile pro
+codefreedom claude --profile ultra
+
+# Run in sandboxed Docker container
+codefreedom claude --sandbox
+
+# Use native Anthropic /login auth (bypass proxy)
+codefreedom claude --native-models
+
+# List available profiles
+codefreedom claude --list-profiles
+
+# Manage the container
+codefreedom claude --status
+codefreedom claude --stop
+```
+
+### 3. Pass Arguments to Claude
+
+```bash
+cf cc -p "Explain this codebase"
+cf cc --resume "<session-id>"
+cf cc --profile pro --worktree feature-branch
+```
+
+## CLI Reference
+
+```
+codefreedom | cf
+│
+├── --init                    Initialize ~/.codefreedom/ with default profiles
+│   └── --force               Overwrite existing configs
+│
+├── claude | cc               Launch Claude Code
+│   ├── --profile NAME        Model profile (default: 'default')
+│   ├── --sandbox             Run in sandboxed Docker container
+│   ├── --native-models       Use native Anthropic /login auth (bypass proxy)
+│   ├── --stop                Stop the container
+│   ├── --status              Show container status
+│   └── --list-profiles       List available profiles
+│
+└── proxy | px                Manage LiteLLM proxy
+    ├── --up                  Start the proxy (default: native)
+    ├── --up --docker         Start via Docker Compose
+    ├── --down                Stop the proxy
+    ├── --status              Show proxy status
+    └── --validate            Validate LiteLLM config
+```
+
+## Profiles
+
+Profiles control which model Claude Code uses and which API endpoint it routes through. Defined in `~/.codefreedom/profiles/claude-code.json`.
+
+| Profile   | Model               | Description                                              |
+| --------- | ------------------- | -------------------------------------------------------- |
+| `default` | `CodeFreedom/Flash` | Base profile — routes through local LiteLLM proxy        |
+| `ultra`   | `CodeFreedom/Ultra` | Architecture, planning, complex reasoning                |
+| `pro`     | `CodeFreedom/Pro`   | Bounded implementation, precise code writing             |
+| `air`     | `CodeFreedom/Air`   | Mechanical scanning, large-file reading                  |
+| `bare`    | _(default)_         | Minimal — no model aliases, routes through LiteLLM proxy |
+
+Create custom profiles by editing `~/.codefreedom/profiles/claude-code.json`.
+A JSON Schema is provided at `~/.codefreedom/profiles/claude-code-profiles.schema.json`.
+
+## Database (Optional)
+
+The proxy runs **stateless by default** — no database, no Prisma, no persistence.
+Model routing works out of the box.
+
+| Backend            | Use Case                                           |
+| ------------------ | -------------------------------------------------- |
+| **None** (default) | Dev/CI — stateless model routing, zero persistence |
+| **PostgreSQL**     | Admin UI, spend tracking, key management, teams    |
+
+See [LiteLLM Proxy → Database](docs/litellm.md#database-backends) for setup.
+
+## Architecture
+
+```
+┌──────────────────────────────────────────────────────────┐
+│                    codefreedom CLI                        │
+│  codefreedom claude  |  codefreedom proxy                │
+└──────────┬───────────────────────┬───────────────────────┘
+           │                       │
+           ▼                       ▼
+   ┌───────────────┐     ┌─────────────────┐
+   │ Claude Code   │     │  LiteLLM Proxy  │
+   │  (Docker)     │────▶│   (Docker)      │
+   │  GPU passthru │     │   :4000          │
+   └───────────────┘     └────────┬────────┘
+                                  │
+                    ┌─────────────┼─────────────┐
+                    ▼             ▼             ▼
+              ┌──────────┐ ┌──────────┐ ┌──────────┐
+              │ DeepSeek │ │  Azure   │ │  DGX     │
+              │  (cloud) │ │ (cloud)  │ │ (local)  │
+              └──────────┘ └──────────┘ └──────────┘
+```
+
+## Documentation
+
+- [Getting Started](docs/getting-started.md) — detailed setup guide
+- [LiteLLM Proxy](docs/litellm.md) — configuration and provider setup
+- [Claude Code Launcher](docs/claude-code.md) — profiles, Docker, and advanced usage
+
+## Requirements
+
+- Python 3.10+
+- Docker (for Docker mode and LiteLLM proxy)
+- NVIDIA Container Toolkit (for GPU passthrough)
+- Node.js + `@anthropic-ai/claude-code` (for native/local mode only)
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).

codefreedom-0.1.0/README.md

@@ -0,0 +1,228 @@
+# CodeFreedom
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](pyproject.toml)
+[![Integration Tests](https://github.com/nilayparikh/codefreedom/actions/workflows/integration-test.yml/badge.svg)](https://github.com/nilayparikh/codefreedom/actions/workflows/integration-test.yml)
+[![PyPI](https://img.shields.io/pypi/v/codefreedom.svg)](https://pypi.org/project/codefreedom/)
+
+**Claude Code launcher and LiteLLM proxy — AI-augmented coding, anywhere.**
+
+CodeFreedom gives you a single CLI tool (`codefreedom` / `cf`) that:
+
+1. **Runs Claude Code** natively or inside a Docker container with GPU passthrough, profile-based model routing, and multi-session support.
+2. **Manages a LiteLLM proxy** — stateless by default, with optional PostgreSQL for the Admin UI, spend tracking, and key management.
+3. **Routes to any provider** — local self-hosted models, cloud APIs (DeepSeek, Azure, NVIDIA, OpenCode Zen), or any OpenAI/Anthropic-compatible endpoint.
+
+## Why CodeFreedom?
+
+CodeFreedom extracts the **LiteLLM proxy** and **Claude Code launcher** from the [`.init`](https://github.com/nilayparikh/spark-init) stack into a standalone, portable tool. Where `.init` is a full Docker Compose stack with PostgreSQL, observability, and llama.cpp backends, CodeFreedom is the lightweight companion you can install anywhere and use with any LiteLLM-compatible backend.
+
+| Feature              | `.init`                 | `codefreedom`                             |
+| -------------------- | ----------------------- | ----------------------------------------- |
+| LiteLLM proxy        | ✅ (part of full stack) | ✅ (standalone, stateless)                |
+| Claude Code launcher | ✅ (`claude-code.py`)   | ✅ (`codefreedom claude`)                 |
+| PostgreSQL           | ✅ (bundled)            | ✅ (optional — connect external Postgres) |
+| llama.cpp backends   | ✅ (bundled)            | ❌ (use .init for local inference)        |
+| Observability        | ✅ (Grafana/Mimir/Loki) | ❌ (use .init)                            |
+| pip installable      | ❌                      | ✅                                        |
+
+## Quick Start
+
+### Installation
+
+**From PyPI (recommended):**
+
+```bash
+pip install codefreedom
+```
+
+**From source:**
+
+```bash
+git clone https://github.com/nilayparikh/codefreedom.git
+cd codefreedom
+pip install -e .
+```
+
+Now you can run `codefreedom` or `cf` from anywhere:
+
+```bash
+codefreedom --help
+cf --help
+```
+
+### Initialize
+
+```bash
+# Creates ~/.codefreedom/ with default profiles and proxy configs
+codefreedom --init
+
+# Overwrite existing files
+codefreedom --init --force
+```
+
+This creates:
+
+```
+~/.codefreedom/
+├── profiles/
+│   ├── claude-code.json                  # Profile definitions
+│   └── claude-code-profiles.schema.json  # JSON Schema for validation
+└── proxy/
+    ├── docker-compose.yml                # Docker Compose for LiteLLM
+    └── config/
+        ├── config.yaml                   # LiteLLM proxy configuration
+        └── providers/                    # Provider-specific configs
+            ├── deepseek.yaml
+            ├── azure-foundry.yaml
+            ├── nvidia.yaml
+            ├── local.yaml
+            ├── openai-compatible.yaml
+            ├── anthropic-compatible.yaml
+            └── opencode-zen.yaml
+```
+
+### 1. Start the LiteLLM Proxy
+
+```bash
+# Edit ~/.codefreedom/proxy/config/config.yaml to configure providers
+# Set LITELLM_MASTER_KEY in your environment
+
+# Start via Docker Compose
+codefreedom proxy --up --docker
+
+# Or start natively (requires: pip install codefreedom[litellm])
+codefreedom proxy --up
+
+# Validate config
+codefreedom proxy --validate
+```
+
+The proxy starts stateless — no database, no Prisma, just model routing.
+See [LiteLLM Proxy → Database](docs/litellm.md#database-backends) for PostgreSQL setup.
+
+### 2. Launch Claude Code
+
+```bash
+# Default: native mode with Flash model
+codefreedom claude
+
+# Short alias
+cf cc
+
+# Pick a model profile
+codefreedom claude --profile pro
+codefreedom claude --profile ultra
+
+# Run in sandboxed Docker container
+codefreedom claude --sandbox
+
+# Use native Anthropic /login auth (bypass proxy)
+codefreedom claude --native-models
+
+# List available profiles
+codefreedom claude --list-profiles
+
+# Manage the container
+codefreedom claude --status
+codefreedom claude --stop
+```
+
+### 3. Pass Arguments to Claude
+
+```bash
+cf cc -p "Explain this codebase"
+cf cc --resume "<session-id>"
+cf cc --profile pro --worktree feature-branch
+```
+
+## CLI Reference
+
+```
+codefreedom | cf
+│
+├── --init                    Initialize ~/.codefreedom/ with default profiles
+│   └── --force               Overwrite existing configs
+│
+├── claude | cc               Launch Claude Code
+│   ├── --profile NAME        Model profile (default: 'default')
+│   ├── --sandbox             Run in sandboxed Docker container
+│   ├── --native-models       Use native Anthropic /login auth (bypass proxy)
+│   ├── --stop                Stop the container
+│   ├── --status              Show container status
+│   └── --list-profiles       List available profiles
+│
+└── proxy | px                Manage LiteLLM proxy
+    ├── --up                  Start the proxy (default: native)
+    ├── --up --docker         Start via Docker Compose
+    ├── --down                Stop the proxy
+    ├── --status              Show proxy status
+    └── --validate            Validate LiteLLM config
+```
+
+## Profiles
+
+Profiles control which model Claude Code uses and which API endpoint it routes through. Defined in `~/.codefreedom/profiles/claude-code.json`.
+
+| Profile   | Model               | Description                                              |
+| --------- | ------------------- | -------------------------------------------------------- |
+| `default` | `CodeFreedom/Flash` | Base profile — routes through local LiteLLM proxy        |
+| `ultra`   | `CodeFreedom/Ultra` | Architecture, planning, complex reasoning                |
+| `pro`     | `CodeFreedom/Pro`   | Bounded implementation, precise code writing             |
+| `air`     | `CodeFreedom/Air`   | Mechanical scanning, large-file reading                  |
+| `bare`    | _(default)_         | Minimal — no model aliases, routes through LiteLLM proxy |
+
+Create custom profiles by editing `~/.codefreedom/profiles/claude-code.json`.
+A JSON Schema is provided at `~/.codefreedom/profiles/claude-code-profiles.schema.json`.
+
+## Database (Optional)
+
+The proxy runs **stateless by default** — no database, no Prisma, no persistence.
+Model routing works out of the box.
+
+| Backend            | Use Case                                           |
+| ------------------ | -------------------------------------------------- |
+| **None** (default) | Dev/CI — stateless model routing, zero persistence |
+| **PostgreSQL**     | Admin UI, spend tracking, key management, teams    |
+
+See [LiteLLM Proxy → Database](docs/litellm.md#database-backends) for setup.
+
+## Architecture
+
+```
+┌──────────────────────────────────────────────────────────┐
+│                    codefreedom CLI                        │
+│  codefreedom claude  |  codefreedom proxy                │
+└──────────┬───────────────────────┬───────────────────────┘
+           │                       │
+           ▼                       ▼
+   ┌───────────────┐     ┌─────────────────┐
+   │ Claude Code   │     │  LiteLLM Proxy  │
+   │  (Docker)     │────▶│   (Docker)      │
+   │  GPU passthru │     │   :4000          │
+   └───────────────┘     └────────┬────────┘
+                                  │
+                    ┌─────────────┼─────────────┐
+                    ▼             ▼             ▼
+              ┌──────────┐ ┌──────────┐ ┌──────────┐
+              │ DeepSeek │ │  Azure   │ │  DGX     │
+              │  (cloud) │ │ (cloud)  │ │ (local)  │
+              └──────────┘ └──────────┘ └──────────┘
+```
+
+## Documentation
+
+- [Getting Started](docs/getting-started.md) — detailed setup guide
+- [LiteLLM Proxy](docs/litellm.md) — configuration and provider setup
+- [Claude Code Launcher](docs/claude-code.md) — profiles, Docker, and advanced usage
+
+## Requirements
+
+- Python 3.10+
+- Docker (for Docker mode and LiteLLM proxy)
+- NVIDIA Container Toolkit (for GPU passthrough)
+- Node.js + `@anthropic-ai/claude-code` (for native/local mode only)
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).