odx-cli 0.0.4__tar.gz → 0.0.6__tar.gz

{odx_cli-0.0.4 → odx_cli-0.0.6}/Cargo.lock

@@ -727,7 +727,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "117725a109d387c937a1533ce01b450cbde6b88abceea8473c4d7a85853cda3c"
 dependencies = [
  "lazy_static",
- "windows-sys 0.52.0",
+ "windows-sys 0.48.0",
 ]
 
 [[package]]
@@ -1541,7 +1541,7 @@ dependencies = [
 
 [[package]]
 name = "git-aggregate-rs"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "assert_cmd",
  "clap",
@@ -2658,7 +2658,7 @@ dependencies = [
 
 [[package]]
 name = "odx-aggregate"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odx-config",
  "odx-core",
@@ -2671,7 +2671,7 @@ dependencies = [
 
 [[package]]
 name = "odx-analyze"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "serde",
  "tempfile",
@@ -2680,11 +2680,11 @@ dependencies = [
 
 [[package]]
 name = "odx-bot"
-version = "0.0.4"
+version = "0.0.6"
 
 [[package]]
 name = "odx-cli"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "assert_cmd",
  "clap",
@@ -2697,6 +2697,7 @@ dependencies = [
  "odx-core",
  "odx-dashboard",
  "odx-dev",
+ "odx-env",
  "odx-forge",
  "odx-git",
  "odx-index",
@@ -2717,7 +2718,7 @@ dependencies = [
 
 [[package]]
 name = "odx-config"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "insta",
  "odx-core",
@@ -2732,11 +2733,11 @@ dependencies = [
 
 [[package]]
 name = "odx-core"
-version = "0.0.4"
+version = "0.0.6"
 
 [[package]]
 name = "odx-dashboard"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "ratatui",
  "serde",
@@ -2745,7 +2746,7 @@ dependencies = [
 
 [[package]]
 name = "odx-dev"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odx-config",
  "serde",
@@ -2755,11 +2756,16 @@ dependencies = [
 
 [[package]]
 name = "odx-env"
-version = "0.0.4"
+version = "0.0.6"
+dependencies = [
+ "odx-config",
+ "pep440_rs",
+ "toml_edit 0.25.17+spec-1.1.0",
+]
 
 [[package]]
 name = "odx-forge"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "apple-native-keyring-store",
  "keyring-core",
@@ -2775,7 +2781,7 @@ dependencies = [
 
 [[package]]
 name = "odx-git"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "futures-util",
  "odx-core",
@@ -2787,7 +2793,7 @@ dependencies = [
 
 [[package]]
 name = "odx-index"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odx-analyze",
  "odx-core",
@@ -2800,7 +2806,7 @@ dependencies = [
 
 [[package]]
 name = "odx-lint"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odoo-lint",
  "tempfile",
@@ -2808,7 +2814,7 @@ dependencies = [
 
 [[package]]
 name = "odx-platform"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odx-analyze",
  "odx-config",
@@ -2823,7 +2829,7 @@ dependencies = [
 
 [[package]]
 name = "odx-port"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odx-core",
  "regex",
@@ -2834,7 +2840,7 @@ dependencies = [
 
 [[package]]
 name = "odx-sync"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "serde",
  "serde_json",
@@ -2844,7 +2850,7 @@ dependencies = [
 
 [[package]]
 name = "odx-vendor"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "odx-analyze",
  "odx-config",
@@ -2861,7 +2867,7 @@ dependencies = [
 
 [[package]]
 name = "odx-verdicts"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "serde",
  "tempfile",
@@ -4026,9 +4032,9 @@ checksum = "eec689c0bc40ff2458a5977b6619cb718087084a18e02a131c599b62d05e1a5f"
 
 [[package]]
 name = "rustls-webpki"
-version = "0.103.15"
+version = "0.103.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f3c3cf1d8b1e7d4927e2d154c3fcb02979afb9939629c62cd9048d4f07b60ac2"
+checksum = "4443b1b6d39d7c663139942cc4558262562d2c84123bb6282ef177009ca8b281"
 dependencies = [
  "ring",
  "rustls-pki-types",
@@ -5278,9 +5284,9 @@ dependencies = [
 
 [[package]]
 name = "webpki-root-certs"
-version = "1.0.9"
+version = "1.0.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b96554aa2acc8ccdb7e1c9a58a7a68dd5d13bccc69cd124cb09406db612a1c9b"
+checksum = "58ec80e73fd8baf57bf0d9615554c75348bda990d6d5bbeab964dd068319fecb"
 dependencies = [
  "rustls-pki-types",
 ]

{odx_cli-0.0.4 → odx_cli-0.0.6}/Cargo.toml

@@ -3,35 +3,36 @@ resolver = "3"
 members = ["crates/*"]
 
 [workspace.package]
-version = "0.0.4"
+version = "0.0.6"
 edition = "2024"
 rust-version = "1.97"
 license = "MIT"
 authors = ["Strategic Efficiency B.V."]
 repository = "https://github.com/getfluvo/odx"
-homepage = "https://github.com/getfluvo/odx"
+homepage = "https://odx.readthedocs.io"
 readme = "README.md"
 keywords = ["odoo", "oca", "git", "workspace", "cli"]
 categories = ["command-line-utilities", "development-tools"]
 
 [workspace.dependencies]
 # Internal crates.
-odx-core = { path = "crates/odx-core", version = "0.0.4" }
-git-aggregate-rs = { path = "crates/git-aggregate-rs", version = "0.0.4" }
-odx-config = { path = "crates/odx-config", version = "0.0.4" }
-odx-git = { path = "crates/odx-git", version = "0.0.4" }
-odx-aggregate = { path = "crates/odx-aggregate", version = "0.0.4" }
-odx-forge = { path = "crates/odx-forge", version = "0.0.4" }
-odx-analyze = { path = "crates/odx-analyze", version = "0.0.4" }
-odx-dashboard = { path = "crates/odx-dashboard", version = "0.0.4" }
-odx-index = { path = "crates/odx-index", version = "0.0.4" }
-odx-port = { path = "crates/odx-port", version = "0.0.4" }
-odx-lint = { path = "crates/odx-lint", version = "0.0.4" }
-odx-verdicts = { path = "crates/odx-verdicts", version = "0.0.4" }
-odx-platform = { path = "crates/odx-platform", version = "0.0.4" }
-odx-vendor = { path = "crates/odx-vendor", version = "0.0.4" }
-odx-dev = { path = "crates/odx-dev", version = "0.0.4" }
-odx-sync = { path = "crates/odx-sync", version = "0.0.4" }
+odx-core = { path = "crates/odx-core", version = "0.0.6" }
+git-aggregate-rs = { path = "crates/git-aggregate-rs", version = "0.0.6" }
+odx-config = { path = "crates/odx-config", version = "0.0.6" }
+odx-git = { path = "crates/odx-git", version = "0.0.6" }
+odx-aggregate = { path = "crates/odx-aggregate", version = "0.0.6" }
+odx-forge = { path = "crates/odx-forge", version = "0.0.6" }
+odx-analyze = { path = "crates/odx-analyze", version = "0.0.6" }
+odx-dashboard = { path = "crates/odx-dashboard", version = "0.0.6" }
+odx-index = { path = "crates/odx-index", version = "0.0.6" }
+odx-port = { path = "crates/odx-port", version = "0.0.6" }
+odx-lint = { path = "crates/odx-lint", version = "0.0.6" }
+odx-verdicts = { path = "crates/odx-verdicts", version = "0.0.6" }
+odx-platform = { path = "crates/odx-platform", version = "0.0.6" }
+odx-vendor = { path = "crates/odx-vendor", version = "0.0.6" }
+odx-dev = { path = "crates/odx-dev", version = "0.0.6" }
+odx-sync = { path = "crates/odx-sync", version = "0.0.6" }
+odx-env = { path = "crates/odx-env", version = "0.0.6" }
 
 # External crates. Versions are pinned in Cargo.lock.
 clap = { version = "4.5", features = ["derive"] }

odx_cli-0.0.6/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: odx-cli
+Version: 0.0.6
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: Odoo
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Build Tools
+License-File: LICENSE
+Summary: Rust-native workspace manager for Odoo projects
+Keywords: odoo,oca,git,workspace,cli
+Home-Page: https://odx.readthedocs.io
+Author: Strategic Efficiency B.V.
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/getfluvo/odx/releases
+Project-URL: Documentation, https://odx.readthedocs.io/
+Project-URL: Homepage, https://odx.readthedocs.io/
+Project-URL: Issues, https://github.com/getfluvo/odx/issues
+Project-URL: Source, https://github.com/getfluvo/odx
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/getfluvo/odx/main/docs/_static/logo.svg" alt="odx logo" width="160">
+</p>
+
+<h1 align="center">odx</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/odx-cli/"><img src="https://img.shields.io/pypi/v/odx-cli?style=flat-square&logo=pypi&logoColor=white&label=PyPI&color=ef662f" alt="PyPI"></a>
+  <a href="https://crates.io/crates/odx-cli"><img src="https://img.shields.io/crates/v/odx-cli?style=flat-square&logo=rust&logoColor=white&label=crates.io&color=ef662f" alt="crates.io"></a>
+  <a href="https://github.com/getfluvo/odx/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/getfluvo/odx/tests.yml?branch=main&style=flat-square&logo=githubactions&logoColor=white&label=tests" alt="Tests"></a>
+  <a href="https://odx.readthedocs.io/"><img src="https://img.shields.io/readthedocs/odx?style=flat-square&logo=readthedocs&logoColor=white&label=docs" alt="Documentation"></a>
+  <a href="https://github.com/getfluvo/odx/blob/main/LICENSE"><img src="https://img.shields.io/github/license/getfluvo/odx?style=flat-square&color=7e5a8c" alt="License: MIT"></a>
+</p>
+
+<!-- start-docs -->
+
+**Odoo Developer eXtension**: one Rust CLI for Odoo projects, driven by a
+single `[tool.odx]` table in `pyproject.toml`.
+
+odx builds a project's addon repositories from upstream branches plus the
+pull requests you need, pins and vaults every commit so rebuilds never break,
+keeps an eye on what upstream merged, ports fixes across Odoo series, migrates
+addons the OCA way, and lints with project context. It replaces
+git-aggregator, uvault and a handful of scripts with one fast binary.
+
+## Install
+
+```console
+$ uv tool install odx-cli       # or: pipx install odx-cli
+$ cargo install odx-cli
+```
+
+Binary wheels are published for Linux (glibc and musl, x86_64 and aarch64),
+macOS (Intel and Apple silicon) and Windows; no Rust toolchain needed.
+
+## Quick start
+
+```console
+$ odx import repos.yaml --write     # start from an existing git-aggregator setup
+$ odx aggregate                     # fetch and build every repository
+$ odx lock                          # pin and vault every merged commit
+$ odx status                        # what upstream merged, what changed
+$ odx lint --only-changed           # odoo-lint with the project's context
+```
+
+## What it does
+
+| Area | Commands |
+|---|---|
+| Aggregate and lock | `aggregate`, `lock`, `verify`, `add`, `drop`, `import`, `export` |
+| Packages and deployment | `vendor`, `build`, platform profiles (wheels, vendored source, Odoo.sh) |
+| Local development | `dev`, `doctor`, `auth`, `sync`, `cache`, `daemon` |
+| Upstream insight | `status`, `suggest`, `verdict`, `dashboard`, `check-deps`, `upgrade`, `sniff`, `stats` |
+| Porting and migration | `port pr/addon/sweep`, `migrate plan/addon/pr/update/pin/unpin/own` |
+| Linting | `lint`, with odoo-lint built in and project rules on top |
+
+Every command supports `--json`. The full reference, configuration and
+compatibility notes are on [Read the Docs](https://odx.readthedocs.io/).
+
+The aggregation engine is also available as a drop-in replacement for
+git-aggregator's `gitaggregate`: `odx git-aggregate`, or the standalone
+[`git-aggregate-rs`](https://pypi.org/project/git-aggregate-rs/) package.
+
+## Status
+
+Pre-alpha (0.0.x): the configuration and the CLI may still change between
+releases. Environment promotion (`odx promote`, `odx env`) and the CI bot
+(`odx bot`) are planned.
+
+<!-- github-only -->
+
+## Packages
+
+| Package | Registry | Purpose |
+|---|---|---|
+| `odx-cli` | [PyPI](https://pypi.org/project/odx-cli/), [crates.io](https://crates.io/crates/odx-cli) | the `odx` command |
+| `git-aggregate-rs` | [PyPI](https://pypi.org/project/git-aggregate-rs/), [crates.io](https://crates.io/crates/git-aggregate-rs) | the gitaggregate drop-in |
+| `odx-*` | [crates.io](https://crates.io/search?q=odx-) | the libraries odx is built from; no stable API |
+
+## Contributing
+
+Contributions are welcome: see
+[CONTRIBUTING.md](https://github.com/getfluvo/odx/blob/main/CONTRIBUTING.md)
+for the development setup and the quality gates (clippy pedantic, 100%
+coverage, MSRV 1.97). This project follows the
+[Contributor Covenant](https://github.com/getfluvo/odx/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+MIT, see [LICENSE](https://github.com/getfluvo/odx/blob/main/LICENSE).
+Maintained by Strategic Efficiency B.V. under the
+[getfluvo](https://github.com/getfluvo) organization.
+
+Built with Rust & AI-accelerated engineering
+

odx_cli-0.0.6/README.md

@@ -0,0 +1,94 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/getfluvo/odx/main/docs/_static/logo.svg" alt="odx logo" width="160">
+</p>
+
+<h1 align="center">odx</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/odx-cli/"><img src="https://img.shields.io/pypi/v/odx-cli?style=flat-square&logo=pypi&logoColor=white&label=PyPI&color=ef662f" alt="PyPI"></a>
+  <a href="https://crates.io/crates/odx-cli"><img src="https://img.shields.io/crates/v/odx-cli?style=flat-square&logo=rust&logoColor=white&label=crates.io&color=ef662f" alt="crates.io"></a>
+  <a href="https://github.com/getfluvo/odx/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/getfluvo/odx/tests.yml?branch=main&style=flat-square&logo=githubactions&logoColor=white&label=tests" alt="Tests"></a>
+  <a href="https://odx.readthedocs.io/"><img src="https://img.shields.io/readthedocs/odx?style=flat-square&logo=readthedocs&logoColor=white&label=docs" alt="Documentation"></a>
+  <a href="https://github.com/getfluvo/odx/blob/main/LICENSE"><img src="https://img.shields.io/github/license/getfluvo/odx?style=flat-square&color=7e5a8c" alt="License: MIT"></a>
+</p>
+
+<!-- start-docs -->
+
+**Odoo Developer eXtension**: one Rust CLI for Odoo projects, driven by a
+single `[tool.odx]` table in `pyproject.toml`.
+
+odx builds a project's addon repositories from upstream branches plus the
+pull requests you need, pins and vaults every commit so rebuilds never break,
+keeps an eye on what upstream merged, ports fixes across Odoo series, migrates
+addons the OCA way, and lints with project context. It replaces
+git-aggregator, uvault and a handful of scripts with one fast binary.
+
+## Install
+
+```console
+$ uv tool install odx-cli       # or: pipx install odx-cli
+$ cargo install odx-cli
+```
+
+Binary wheels are published for Linux (glibc and musl, x86_64 and aarch64),
+macOS (Intel and Apple silicon) and Windows; no Rust toolchain needed.
+
+## Quick start
+
+```console
+$ odx import repos.yaml --write     # start from an existing git-aggregator setup
+$ odx aggregate                     # fetch and build every repository
+$ odx lock                          # pin and vault every merged commit
+$ odx status                        # what upstream merged, what changed
+$ odx lint --only-changed           # odoo-lint with the project's context
+```
+
+## What it does
+
+| Area | Commands |
+|---|---|
+| Aggregate and lock | `aggregate`, `lock`, `verify`, `add`, `drop`, `import`, `export` |
+| Packages and deployment | `vendor`, `build`, platform profiles (wheels, vendored source, Odoo.sh) |
+| Local development | `dev`, `doctor`, `auth`, `sync`, `cache`, `daemon` |
+| Upstream insight | `status`, `suggest`, `verdict`, `dashboard`, `check-deps`, `upgrade`, `sniff`, `stats` |
+| Porting and migration | `port pr/addon/sweep`, `migrate plan/addon/pr/update/pin/unpin/own` |
+| Linting | `lint`, with odoo-lint built in and project rules on top |
+
+Every command supports `--json`. The full reference, configuration and
+compatibility notes are on [Read the Docs](https://odx.readthedocs.io/).
+
+The aggregation engine is also available as a drop-in replacement for
+git-aggregator's `gitaggregate`: `odx git-aggregate`, or the standalone
+[`git-aggregate-rs`](https://pypi.org/project/git-aggregate-rs/) package.
+
+## Status
+
+Pre-alpha (0.0.x): the configuration and the CLI may still change between
+releases. Environment promotion (`odx promote`, `odx env`) and the CI bot
+(`odx bot`) are planned.
+
+<!-- github-only -->
+
+## Packages
+
+| Package | Registry | Purpose |
+|---|---|---|
+| `odx-cli` | [PyPI](https://pypi.org/project/odx-cli/), [crates.io](https://crates.io/crates/odx-cli) | the `odx` command |
+| `git-aggregate-rs` | [PyPI](https://pypi.org/project/git-aggregate-rs/), [crates.io](https://crates.io/crates/git-aggregate-rs) | the gitaggregate drop-in |
+| `odx-*` | [crates.io](https://crates.io/search?q=odx-) | the libraries odx is built from; no stable API |
+
+## Contributing
+
+Contributions are welcome: see
+[CONTRIBUTING.md](https://github.com/getfluvo/odx/blob/main/CONTRIBUTING.md)
+for the development setup and the quality gates (clippy pedantic, 100%
+coverage, MSRV 1.97). This project follows the
+[Contributor Covenant](https://github.com/getfluvo/odx/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+MIT, see [LICENSE](https://github.com/getfluvo/odx/blob/main/LICENSE).
+Maintained by Strategic Efficiency B.V. under the
+[getfluvo](https://github.com/getfluvo) organization.
+
+Built with Rust & AI-accelerated engineering

{odx_cli-0.0.4 → odx_cli-0.0.6}/crates/git-aggregate-rs/README.md

@@ -6,6 +6,11 @@ same flags (`-c`, `-p`, `-d`, `-e`, `--env-file`, `-f`, `-j`, `--log-level`,
 `--no-color`), with opt-in extensions: `--allow-shell`, `--rebase`, `--mergiraf`
 and `--json`.
 
+```console
+$ uv tool install git-aggregate-rs     # or: pipx install git-aggregate-rs
+$ cargo install git-aggregate-rs
+```
+
 ```console
 $ git-aggregate-rs -c repos.yaml
 $ git-aggregate-rs -c repos.yaml -d '*/sale-*' -j 8

{odx_cli-0.0.4 → odx_cli-0.0.6}/crates/git-aggregate-rs/pyproject.toml

@@ -19,8 +19,11 @@ classifiers = [
 dynamic = ["version"]
 
 [project.urls]
-Homepage = "https://github.com/getfluvo/odx"
+Homepage = "https://odx.readthedocs.io/compatibility.html"
+Documentation = "https://odx.readthedocs.io/compatibility.html"
+Source = "https://github.com/getfluvo/odx/tree/main/crates/git-aggregate-rs"
 Issues = "https://github.com/getfluvo/odx/issues"
+Changelog = "https://github.com/getfluvo/odx/releases"
 
 [tool.maturin]
 bindings = "bin"

odx_cli-0.0.6/crates/odx-aggregate/README.md

@@ -0,0 +1,19 @@
+# odx-aggregate
+
+Aggregation, locking, vaulting, the force-push guard rail, auto-update and verification for odx.
+
+Part of [odx](https://github.com/getfluvo/odx), the Odoo Developer eXtension.
+This crate is one of the building blocks of the `odx` command
+([`odx-cli`](https://crates.io/crates/odx-cli)); its API follows what odx needs
+and is not stable. To use odx, install the command:
+
+```console
+$ uv tool install odx-cli
+$ cargo install odx-cli
+```
+
+- User documentation: [odx.readthedocs.io](https://odx.readthedocs.io/)
+- API documentation: [docs.rs/odx-aggregate](https://docs.rs/odx-aggregate)
+- Source and issues: [github.com/getfluvo/odx](https://github.com/getfluvo/odx)
+
+MIT licensed. Built with Rust & AI-accelerated engineering.

odx_cli-0.0.6/crates/odx-analyze/README.md

@@ -0,0 +1,19 @@
+# odx-analyze
+
+Odoo manifest analysis for odx: check-deps, stats, sniff, status, suggest and upgrade readiness.
+
+Part of [odx](https://github.com/getfluvo/odx), the Odoo Developer eXtension.
+This crate is one of the building blocks of the `odx` command
+([`odx-cli`](https://crates.io/crates/odx-cli)); its API follows what odx needs
+and is not stable. To use odx, install the command:
+
+```console
+$ uv tool install odx-cli
+$ cargo install odx-cli
+```
+
+- User documentation: [odx.readthedocs.io](https://odx.readthedocs.io/)
+- API documentation: [docs.rs/odx-analyze](https://docs.rs/odx-analyze)
+- Source and issues: [github.com/getfluvo/odx](https://github.com/getfluvo/odx)
+
+MIT licensed. Built with Rust & AI-accelerated engineering.

{odx_cli-0.0.4 → odx_cli-0.0.6}/crates/odx-cli/Cargo.toml

@@ -28,6 +28,7 @@ odx-aggregate.workspace = true
 odx-analyze.workspace = true
 odx-config.workspace = true
 odx-dev.workspace = true
+odx-env.workspace = true
 odx-core = { workspace = true, features = ["system"] }
 odx-forge.workspace = true
 odx-git.workspace = true

odx_cli-0.0.6/crates/odx-cli/README.md

@@ -0,0 +1,94 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/getfluvo/odx/main/docs/_static/logo.svg" alt="odx logo" width="160">
+</p>
+
+<h1 align="center">odx</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/odx-cli/"><img src="https://img.shields.io/pypi/v/odx-cli?style=flat-square&logo=pypi&logoColor=white&label=PyPI&color=ef662f" alt="PyPI"></a>
+  <a href="https://crates.io/crates/odx-cli"><img src="https://img.shields.io/crates/v/odx-cli?style=flat-square&logo=rust&logoColor=white&label=crates.io&color=ef662f" alt="crates.io"></a>
+  <a href="https://github.com/getfluvo/odx/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/getfluvo/odx/tests.yml?branch=main&style=flat-square&logo=githubactions&logoColor=white&label=tests" alt="Tests"></a>
+  <a href="https://odx.readthedocs.io/"><img src="https://img.shields.io/readthedocs/odx?style=flat-square&logo=readthedocs&logoColor=white&label=docs" alt="Documentation"></a>
+  <a href="https://github.com/getfluvo/odx/blob/main/LICENSE"><img src="https://img.shields.io/github/license/getfluvo/odx?style=flat-square&color=7e5a8c" alt="License: MIT"></a>
+</p>
+
+<!-- start-docs -->
+
+**Odoo Developer eXtension**: one Rust CLI for Odoo projects, driven by a
+single `[tool.odx]` table in `pyproject.toml`.
+
+odx builds a project's addon repositories from upstream branches plus the
+pull requests you need, pins and vaults every commit so rebuilds never break,
+keeps an eye on what upstream merged, ports fixes across Odoo series, migrates
+addons the OCA way, and lints with project context. It replaces
+git-aggregator, uvault and a handful of scripts with one fast binary.
+
+## Install
+
+```console
+$ uv tool install odx-cli       # or: pipx install odx-cli
+$ cargo install odx-cli
+```
+
+Binary wheels are published for Linux (glibc and musl, x86_64 and aarch64),
+macOS (Intel and Apple silicon) and Windows; no Rust toolchain needed.
+
+## Quick start
+
+```console
+$ odx import repos.yaml --write     # start from an existing git-aggregator setup
+$ odx aggregate                     # fetch and build every repository
+$ odx lock                          # pin and vault every merged commit
+$ odx status                        # what upstream merged, what changed
+$ odx lint --only-changed           # odoo-lint with the project's context
+```
+
+## What it does
+
+| Area | Commands |
+|---|---|
+| Aggregate and lock | `aggregate`, `lock`, `verify`, `add`, `drop`, `import`, `export` |
+| Packages and deployment | `vendor`, `build`, platform profiles (wheels, vendored source, Odoo.sh) |
+| Local development | `dev`, `doctor`, `auth`, `sync`, `cache`, `daemon` |
+| Upstream insight | `status`, `suggest`, `verdict`, `dashboard`, `check-deps`, `upgrade`, `sniff`, `stats` |
+| Porting and migration | `port pr/addon/sweep`, `migrate plan/addon/pr/update/pin/unpin/own` |
+| Linting | `lint`, with odoo-lint built in and project rules on top |
+
+Every command supports `--json`. The full reference, configuration and
+compatibility notes are on [Read the Docs](https://odx.readthedocs.io/).
+
+The aggregation engine is also available as a drop-in replacement for
+git-aggregator's `gitaggregate`: `odx git-aggregate`, or the standalone
+[`git-aggregate-rs`](https://pypi.org/project/git-aggregate-rs/) package.
+
+## Status
+
+Pre-alpha (0.0.x): the configuration and the CLI may still change between
+releases. Environment promotion (`odx promote`, `odx env`) and the CI bot
+(`odx bot`) are planned.
+
+<!-- github-only -->
+
+## Packages
+
+| Package | Registry | Purpose |
+|---|---|---|
+| `odx-cli` | [PyPI](https://pypi.org/project/odx-cli/), [crates.io](https://crates.io/crates/odx-cli) | the `odx` command |
+| `git-aggregate-rs` | [PyPI](https://pypi.org/project/git-aggregate-rs/), [crates.io](https://crates.io/crates/git-aggregate-rs) | the gitaggregate drop-in |
+| `odx-*` | [crates.io](https://crates.io/search?q=odx-) | the libraries odx is built from; no stable API |
+
+## Contributing
+
+Contributions are welcome: see
+[CONTRIBUTING.md](https://github.com/getfluvo/odx/blob/main/CONTRIBUTING.md)
+for the development setup and the quality gates (clippy pedantic, 100%
+coverage, MSRV 1.97). This project follows the
+[Contributor Covenant](https://github.com/getfluvo/odx/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+MIT, see [LICENSE](https://github.com/getfluvo/odx/blob/main/LICENSE).
+Maintained by Strategic Efficiency B.V. under the
+[getfluvo](https://github.com/getfluvo) organization.
+
+Built with Rust & AI-accelerated engineering