cli-consumption 0.0.1__py3-none-any.whl

cli_consumption-0.0.1.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.5
+Name: cli-consumption
+Version: 0.0.1
+Summary: Analyze and consolidate AI coding CLI consumption across machines.
+Project-URL: Homepage, https://github.com/Guillaume-Lombardo/cli-consumption
+Project-URL: Documentation, https://github.com/Guillaume-Lombardo/cli-consumption#readme
+Project-URL: Issues, https://github.com/Guillaume-Lombardo/cli-consumption/issues
+Project-URL: Repository, https://github.com/Guillaume-Lombardo/cli-consumption.git
+Author-email: Guillaume Lombardo <lombardo.guillaume@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ai,cli,codex,observability,tokens,usage
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.14
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.27
+Requires-Dist: psycopg[binary]>=3.2
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn>=0.34
+Description-Content-Type: text/markdown
+
+# CLI Consumption
+
+CLI Consumption is a local-first Python package for measuring how AI coding CLIs use
+models, tokens, tools, conversations, and turns. It can analyze one workstation,
+consolidate copied data from several machines, or send metadata-only snapshots to a
+central collector.
+
+Codex is fully supported. Claude Code, OpenCode, Kilo Code, and Pi are planned behind
+the same provider-neutral adapter contract.
+
+The collector deliberately excludes prompts, responses, tool arguments, and
+credentials. See [Privacy](docs/privacy.md) before sharing a database or export.
+
+## Quick start
+
+The project requires Python 3.14 or newer and uses
+[`uv`](https://docs.astral.sh/uv/) for every development and execution workflow.
+
+From a checkout:
+
+```bash
+uv sync
+uv run cli-consumption collect
+uv run cli-consumption export --output reports
+```
+
+Open `reports/dashboard.html` locally. The generated dashboard is self-contained and
+makes no network requests.
+
+The dashboard supports time, provider, machine, project, and model filters. It reports
+period-over-period activity, token composition, cache efficiency, turn latency and
+duration distributions, technical throughput, context pressure, content-free work-item
+duration and reliability, configuration cohorts, compactions, subagent delegation, and
+ingestion quality. Token events are local usage metadata rather than billing records,
+and a technically completed turn is not a measure of task quality or productivity.
+
+For a dashboard that is safer to share, omit the detailed CSV exports, pseudonymize
+machine, project, model, and role labels, group tool names, round timestamps to days,
+and hide small rows in the cohort-comparison view:
+
+```bash
+uv run cli-consumption export --output shared-report --share-safe
+```
+
+Share-safe reports still disclose aggregate work patterns and must be treated as
+private operational data.
+
+From PyPI, the CLI can run without a permanent installation:
+
+```bash
+uv tool run cli-consumption collect
+uv tool run cli-consumption export --output reports
+```
+
+To run the latest unreleased GitHub source instead:
+
+```bash
+uv tool run --from git+https://github.com/Guillaume-Lombardo/cli-consumption \
+  cli-consumption providers
+```
+
+## Collect from one or more machines
+
+With no source option, `collect` reads `~/.codex` and labels it with the local
+hostname:
+
+```bash
+uv run cli-consumption collect --database usage.sqlite
+```
+
+For an offline multi-machine workflow, copy only each machine's Codex `sessions/`
+directory into a trusted analysis location. Do not copy `auth.json` or other
+credentials. Then repeat `--source`:
+
+```bash
+uv run cli-consumption collect \
+  --source desktop=/data/codex/desktop \
+  --source laptop=/data/codex/laptop \
+  --source server=/data/codex/server \
+  --database usage.sqlite
+```
+
+Globally identical conversation IDs are deduplicated. If copies differ, the most
+complete rollout wins. Explicit project mappings use the longest matching original
+working-directory prefix:
+
+```bash
+uv run cli-consumption collect \
+  --source desktop=/data/codex/desktop \
+  --project cli-consumption=/home/me/dev/cli-consumption
+```
+
+## SQLite and PostgreSQL
+
+A file path selects SQLite. A SQLAlchemy URL selects PostgreSQL:
+
+```bash
+uv run cli-consumption collect --database usage.sqlite
+uv run cli-consumption collect \
+  --database postgresql+psycopg://usage@localhost/cli_consumption
+```
+
+Pass credentials through environment variables or a secret manager rather than shell
+history. `CLI_CONSUMPTION_DATABASE` can supply the database setting.
+
+## Central collector API
+
+Offline imports are the simplest choice for personal use and air-gapped machines. A
+central API is useful for recurring collection across machines.
+
+Start the collector locally:
+
+```bash
+export CLI_CONSUMPTION_API_TOKEN="$(your-secret-provider)"
+uv run cli-consumption serve \
+  --database postgresql+psycopg://usage@localhost/cli_consumption \
+  --host 0.0.0.0
+```
+
+Send a snapshot from another machine:
+
+```bash
+export CLI_CONSUMPTION_API_TOKEN="$(your-secret-provider)"
+uv run cli-consumption sync --endpoint https://usage.example.test
+```
+
+The application refuses to bind beyond localhost without a token. Production
+deployments must also place TLS and normal operational controls in front of the ASGI
+server. See [Architecture](docs/architecture.md) for trade-offs.
+
+## Commands
+
+```text
+cli-consumption collect    Collect local or copied provider data into SQL
+cli-consumption sync       Collect and send a snapshot to a central API
+cli-consumption serve      Run the central collection API
+cli-consumption export     Write CSV tables and the HTML dashboard
+cli-consumption providers  Show supported and planned providers
+```
+
+Run `uv run cli-consumption COMMAND --help` for every option.
+
+## Development
+
+```bash
+uv sync --all-groups
+uv run pre-commit install
+uv run pre-commit run --all-files
+uv run ruff format --check .
+uv run ruff check .
+uv run ty check
+uv run pytest --cov --cov-report=term-missing
+uv build
+```
+
+Development follows short-lived branches and squash-merged pull requests into a
+protected `main`. Read [CONTRIBUTING.md](CONTRIBUTING.md) and [AGENTS.md](AGENTS.md)
+before changing the project.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE). It provides permissive reuse plus an
+explicit patent grant and contribution protections appropriate for an extensible
+developer tool.

cli_consumption-0.0.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+cli_consumption/__init__.py,sha256=psFnKIMRERwCv6bcyhGRzSfpbSjPZUtoBWUYHxpgKfs,324
+cli_consumption/__main__.py,sha256=cQgQXrg0bBUyBuuzsKqE_Mmi1tNwzT_kfujDjDnUzu4,74
+cli_consumption/api.py,sha256=Ws6-bnqVxoSjPjFSAxqY0Tv1H3c9Gkq5Eoj5_oPqSe8,2572
+cli_consumption/cli.py,sha256=KtCAq7KKp9YdHmjx0AbW93z_bVbu2hUZySPGKWchQnM,8077
+cli_consumption/dashboard.py,sha256=Q362mXst_WiJ5mzML_f2tY0VhaYTW-bIEgq5N-JPwP8,47976
+cli_consumption/exporting.py,sha256=GNaEHjJJtgThRtB-apOOrX0kLue2sDcKABbIVn9_ysQ,970
+cli_consumption/models.py,sha256=GFXsKoUt5hgWTv1J7x9dXWzWp0RtmpkXA_guVzYCe_c,2229
+cli_consumption/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli_consumption/storage.py,sha256=j3foyKqZbttnaj4TQ3xfGFoVKdX9BTn70In--YBKWQQ,20401
+cli_consumption/sync.py,sha256=GCVy-zojRDGkvrjYQACTFYXf3fiPZwcimP08Qprlahg,664
+cli_consumption/adapters/__init__.py,sha256=_Hm0O_yI5ap6vDp9QIkGmfZY_Jsd_hoOBusrK4ArUB0,84
+cli_consumption/adapters/base.py,sha256=A8-mVFHUAnNxlYid45TXhiREj56EllCO7ctnBfd0aPI,379
+cli_consumption/adapters/codex.py,sha256=664js3mMhlrdT-6H1vJ4jm85hS32Gjkbb81ggN7sUYs,23777
+cli_consumption-0.0.1.dist-info/METADATA,sha256=64vk7zajnBOZ7SSmNc3xIIkW1EpNOdtu4TRRKBTteZk,6595
+cli_consumption-0.0.1.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+cli_consumption-0.0.1.dist-info/entry_points.txt,sha256=EoLs_T0L-3eFbV3OHYOpsnJW6WrOclVpqAdLdSAlKrs,60
+cli_consumption-0.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+cli_consumption-0.0.1.dist-info/licenses/NOTICE,sha256=-G_NFgE7OlBI2V3q6LicFEjI9zz5hnsC9vMJb1fQWtI,115
+cli_consumption-0.0.1.dist-info/RECORD,,

cli_consumption-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

cli_consumption-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cli-consumption = cli_consumption.cli:app

cli_consumption-0.0.1.dist-info/licenses/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 [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.

cli_consumption-0.0.1.dist-info/licenses/NOTICE

@@ -0,0 +1,4 @@
+CLI Consumption
+Copyright 2026 Guillaume Lombardo
+
+This product is licensed under the Apache License, Version 2.0.