adhelm 0.1.0__tar.gz

adhelm-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Credentials and local configuration
+.env
+.env.*
+!.env.example
+*.key
+*.pem
+*.p12
+*.pfx
+credentials/
+secrets/
+
+# Local application data
+.local/
+*.db
+*.sqlite
+*.sqlite3
+*.log
+
+# Python
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+
+# Build and packaging
+build/
+dist/
+*.egg-info/
+
+# Editors and operating systems
+.DS_Store
+.idea/
+.vscode/
+

adhelm-0.1.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.

adhelm-0.1.0/NOTICE

@@ -0,0 +1,10 @@
+AdHelm
+Copyright 2026 The AdHelm authors
+
+This product is licensed under the Apache License, Version 2.0; see the LICENSE
+file. Section 6 of that license grants no permission to use the AdHelm name or
+marks except to describe the origin of the work, and a redistribution must not
+imply endorsement by the AdHelm authors.
+
+AdHelm bundles no third-party code. The packages it installs as dependencies
+keep their own licenses.

adhelm-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.5
+Name: adhelm
+Version: 0.1.0
+Summary: Local, read-only CLI for AI agents to audit and report on your ad and analytics accounts
+Project-URL: Homepage, https://aptsonic.com/adhelm
+Project-URL: Source, https://github.com/jasonhowie/adhelm
+Project-URL: Issues, https://github.com/jasonhowie/adhelm/issues
+Project-URL: Changelog, https://github.com/jasonhowie/adhelm/blob/main/CHANGELOG.md
+Author: The AdHelm authors
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: advertising,agents,analytics,audit,cli,ga4,google-ads,meta-ads
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Office/Business
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: cryptography<51,>=50
+Requires-Dist: google-auth<3,>=2.40
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: keyring<26,>=25
+Requires-Dist: pillow<13,>=11
+Requires-Dist: portalocker<4,>=3
+Requires-Dist: pydantic<3,>=2.11
+Requires-Dist: rfc8785<1,>=0.1.4
+Requires-Dist: typer<1,>=0.16
+Requires-Dist: tzdata>=2025.2
+Description-Content-Type: text/markdown
+
+# AdHelm
+
+> AdHelm 0.1.0 lets a marketer direct their own AI agent through a local,
+> free, Apache-2.0 CLI to connect their own ad and analytics accounts, inventory
+> them, report aggregate performance, audit them, and receive evidence-backed
+> recommendations, with append-only local history and redacted exports. It
+> makes no changes to any advertising or analytics account.
+
+AdHelm is a command-line tool built to be driven by your AI agent, such as
+Claude Code or Codex. You describe the goal in conversation. The agent discovers
+the installed commands, calls them, and reports back in the form you prefer. You
+do not need to know shell syntax. Direct human use of the CLI is possible but
+secondary.
+
+Everything runs on your machine. There is no hosted service, telemetry, account,
+license key, or paid tier. You register your own provider applications and keep
+your own credentials.
+
+## Status
+
+`0.1.0` is the first public release and it is **read-only**. Every command that
+would change an advertising or analytics account is listed by `adhelm discover`
+with status `UNRELEASED` and is refused at runtime; see
+[What 0.1.0 does not do](#what-010-does-not-do). The release is gated by the
+[0.1.0 release definition](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/release-0.1.0.md). It makes no `COMPLETE`,
+live-parity, write-support or compliance claim.
+
+## What you can do
+
+For each provider below, in `0.1.0`:
+
+- enroll your own application or key locally, check its status, refresh it where
+  the provider supports refresh, remove it locally, and read the provider's
+  revocation guidance;
+- read the account identity, a fixed inventory and a fixed daily aggregate
+  report;
+- run audits that state, per dimension, what was and was not read, and receive
+  recommendations that name their evidence and change nothing;
+- keep an append-only local history, verify it, reconcile out-of-band changes,
+  and export deterministic CSV and JSON projections from a rebuildable SQLite
+  index; and
+- ask for optional documents, spreadsheets or HTML reports when you want them.
+  Compact conversational summaries are the default.
+
+Two [bundled skills](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/agent-skills.md) teach your agent the diagnose,
+recommend and verify loop. `adhelm guidance catalog` lists them.
+
+## Install
+
+AdHelm needs Python 3.12 or newer and runs on macOS, Linux and Windows. CPython
+3.12 is the tested and supported version.
+
+```sh
+uv tool install adhelm
+```
+
+or
+
+```sh
+pipx install adhelm
+```
+
+Check the install:
+
+```sh
+adhelm version
+```
+
+To work on AdHelm itself, see [CONTRIBUTING.md](https://github.com/jasonhowie/adhelm/blob/v0.1.0/CONTRIBUTING.md).
+
+## First run
+
+Ask your agent to start with `adhelm discover`. It returns the installed
+commands, schemas, exit codes, release policy and provider labels, and it makes
+no network or credential-store call. You can run the same commands yourself:
+
+```sh
+adhelm init
+adhelm doctor
+adhelm discover
+adhelm guidance catalog
+```
+
+`init` creates local defaults without credentials. `doctor` reports local
+readiness and does not contact any provider. Without `--data-dir`, local data
+lives in the platform data directory: `~/.local/share/adhelm` on Linux,
+`~/Library/Application Support/adhelm` on macOS and `%LOCALAPPDATA%\adhelm` on
+Windows.
+
+Then follow the setup guide for each provider you use. A guide covers which
+developer app or key to create, the scopes it needs, the redirect configuration,
+access-tier limits that matter for read-only use, the enrollment command, and how
+to revoke. Secrets are entered through a local interactive handoff and stored in
+your operating system's credential store. They are never accepted in command
+arguments or JSON.
+
+## Providers
+
+Each provider carries exactly one release label. `LIVE_PILOTED` means the
+provider is fixture-verified and was read-piloted on a live account, with a
+redacted pilot record committed under [`docs/pilots/`](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/pilots/README.md).
+`EXPERIMENTAL` means it is fixture-verified only and has no live evidence. The
+label states evidence and never a capability. `adhelm discover`, `adhelm doctor`
+and every output that names a provider show the same label.
+
+| Provider | Label | Read in 0.1.0 | Setup |
+| --- | --- | --- | --- |
+| Google Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/google_ads.md) |
+| Meta Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/meta_ads.md) |
+| LinkedIn Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/linkedin_ads.md) |
+| TikTok Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/tiktok_ads.md) |
+| Reddit Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/reddit_ads.md) |
+| OpenAI Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/openai_ads.md) |
+| GA4 | `EXPERIMENTAL` | Data API aggregate reporting, read-only Admin inventory, audit | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/ga4.md) |
+| GTM | `EXPERIMENTAL` | Container inventory, dependency graph, read-only audit | [setup](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/setup/gtm.md) |
+
+`doctor` expects GA4. GTM is optional, and a provider you have not configured
+does not block work on the others. Provider quotas, approvals and access tiers
+belong to the provider. You must obtain API access yourself, and a provider can
+change or withdraw its API.
+
+## What 0.1.0 does not do
+
+- **No remote writes.** Pausing, creating, activating, maintaining, GA4 Admin
+  edits and GTM staging, versioning and publishing are all refused with
+  `WRITES_NOT_RELEASED` (exit code `3`) before any credential-store access,
+  ledger `APPLY_STARTED` entry or network request. No configuration value,
+  environment variable, flag or edited file enables them. Offline compile, plan
+  and preview commands remain available and say that execution is unreleased.
+  When your agent recommends a change, you make it by hand in the provider's own
+  interface.
+- **No CRM attribution.** Salesforce and HubSpot are not part of `0.1.0`.
+- **`EXPERIMENTAL` providers have no live evidence.** Their reports and audits
+  are tested against fixtures, and their totals have not been compared with the
+  provider's own interface.
+- **Some reads are bounded, not exhaustive, and some are narrower than the
+  provider's API.** Where a provider documents no pagination, such as LinkedIn
+  analytics, audits say so instead of presenting the result as complete. The
+  [capability matrix](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/capability-matrix.md) lists each provider's limits.
+- **Money is read in a few currencies only.** Google Ads, LinkedIn Ads, Reddit
+  Ads and OpenAI Ads project money exactly only for USD accounts. Meta Ads
+  accepts AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, MXN, NOK, NZD, SEK, SGD and USD.
+  TikTok Ads accepts AUD, CAD, EUR, GBP, JPY and USD. A read that carries money
+  for an account in any other currency is refused with `UNSUPPORTED_CURRENCY`
+  rather than converted approximately, so check your account currency before you
+  register an application.
+
+## Privacy and safety
+
+- The default runtime has no vendor proxy, hosted database, telemetry, crash
+  upload, automatic updater, or remote license heartbeat.
+- Interactive secrets live in the operating system credential store.
+  Environment variables are for explicitly configured CI use only.
+- Logs, plans, evidence and exports are local, redacted, deterministic and
+  user-initiated. Raw provider responses are not persisted by default.
+- Output your agent reads follows the same redaction rules, but your agent may
+  forward what it reads to its model. Share only what you are comfortable
+  sending there.
+- Each configured provider still receives the requests you make of it. Local
+  execution reduces vendor custody. It does not make you compliant with HIPAA,
+  GLBA or any other regime, and it does not replace legal, provider-policy or
+  security review.
+
+## Documentation
+
+- [0.1.0 release definition](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/release-0.1.0.md) and
+  [ADR 0013](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/adr/0013-open-source-release.md), which decide this release
+- [Product brief](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/product-brief.md) and
+  [definition of done](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/definition-of-done.md) for the `v1.0.0` target
+- [Bundled agent skills](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/agent-skills.md)
+- [Capability matrix](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/capability-matrix.md), the evidence level of every
+  provider operation
+- [Direct and delegated authorization](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/authorization-policy.md)
+- [Reporting schema](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/reporting-schema.md) and
+  [local history ledger and exports](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/local-ledger-and-exports.md)
+- [Threat model](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/threat-model.md) and [egress map](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/egress-map.md)
+- [Architecture decisions](https://github.com/jasonhowie/adhelm/blob/v0.1.0/docs/adr/)
+- [AGENTS.md](https://github.com/jasonhowie/adhelm/blob/v0.1.0/AGENTS.md), the rules every contributor and agent follows
+
+## Contributing and security
+
+Contributions are welcome under the Developer Certificate of Origin; read
+[CONTRIBUTING.md](https://github.com/jasonhowie/adhelm/blob/v0.1.0/CONTRIBUTING.md). Report a vulnerability privately as
+[SECURITY.md](https://github.com/jasonhowie/adhelm/blob/v0.1.0/SECURITY.md) describes, never in a public issue. Participation is
+governed by the [Code of Conduct](https://github.com/jasonhowie/adhelm/blob/v0.1.0/CODE_OF_CONDUCT.md). Changes are recorded in
+the [changelog](https://github.com/jasonhowie/adhelm/blob/v0.1.0/CHANGELOG.md).
+
+## License
+
+AdHelm is licensed under the Apache License, Version 2.0; see the `LICENSE`
+file. The license does not grant rights to the AdHelm name or marks, and a fork
+that redistributes the software must not imply endorsement by this project.

adhelm-0.1.0/README.md

@@ -0,0 +1,192 @@
+# AdHelm
+
+> AdHelm 0.1.0 lets a marketer direct their own AI agent through a local,
+> free, Apache-2.0 CLI to connect their own ad and analytics accounts, inventory
+> them, report aggregate performance, audit them, and receive evidence-backed
+> recommendations, with append-only local history and redacted exports. It
+> makes no changes to any advertising or analytics account.
+
+AdHelm is a command-line tool built to be driven by your AI agent, such as
+Claude Code or Codex. You describe the goal in conversation. The agent discovers
+the installed commands, calls them, and reports back in the form you prefer. You
+do not need to know shell syntax. Direct human use of the CLI is possible but
+secondary.
+
+Everything runs on your machine. There is no hosted service, telemetry, account,
+license key, or paid tier. You register your own provider applications and keep
+your own credentials.
+
+## Status
+
+`0.1.0` is the first public release and it is **read-only**. Every command that
+would change an advertising or analytics account is listed by `adhelm discover`
+with status `UNRELEASED` and is refused at runtime; see
+[What 0.1.0 does not do](#what-010-does-not-do). The release is gated by the
+[0.1.0 release definition](docs/release-0.1.0.md). It makes no `COMPLETE`,
+live-parity, write-support or compliance claim.
+
+## What you can do
+
+For each provider below, in `0.1.0`:
+
+- enroll your own application or key locally, check its status, refresh it where
+  the provider supports refresh, remove it locally, and read the provider's
+  revocation guidance;
+- read the account identity, a fixed inventory and a fixed daily aggregate
+  report;
+- run audits that state, per dimension, what was and was not read, and receive
+  recommendations that name their evidence and change nothing;
+- keep an append-only local history, verify it, reconcile out-of-band changes,
+  and export deterministic CSV and JSON projections from a rebuildable SQLite
+  index; and
+- ask for optional documents, spreadsheets or HTML reports when you want them.
+  Compact conversational summaries are the default.
+
+Two [bundled skills](docs/agent-skills.md) teach your agent the diagnose,
+recommend and verify loop. `adhelm guidance catalog` lists them.
+
+## Install
+
+AdHelm needs Python 3.12 or newer and runs on macOS, Linux and Windows. CPython
+3.12 is the tested and supported version.
+
+```sh
+uv tool install adhelm
+```
+
+or
+
+```sh
+pipx install adhelm
+```
+
+Check the install:
+
+```sh
+adhelm version
+```
+
+To work on AdHelm itself, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## First run
+
+Ask your agent to start with `adhelm discover`. It returns the installed
+commands, schemas, exit codes, release policy and provider labels, and it makes
+no network or credential-store call. You can run the same commands yourself:
+
+```sh
+adhelm init
+adhelm doctor
+adhelm discover
+adhelm guidance catalog
+```
+
+`init` creates local defaults without credentials. `doctor` reports local
+readiness and does not contact any provider. Without `--data-dir`, local data
+lives in the platform data directory: `~/.local/share/adhelm` on Linux,
+`~/Library/Application Support/adhelm` on macOS and `%LOCALAPPDATA%\adhelm` on
+Windows.
+
+Then follow the setup guide for each provider you use. A guide covers which
+developer app or key to create, the scopes it needs, the redirect configuration,
+access-tier limits that matter for read-only use, the enrollment command, and how
+to revoke. Secrets are entered through a local interactive handoff and stored in
+your operating system's credential store. They are never accepted in command
+arguments or JSON.
+
+## Providers
+
+Each provider carries exactly one release label. `LIVE_PILOTED` means the
+provider is fixture-verified and was read-piloted on a live account, with a
+redacted pilot record committed under [`docs/pilots/`](docs/pilots/README.md).
+`EXPERIMENTAL` means it is fixture-verified only and has no live evidence. The
+label states evidence and never a capability. `adhelm discover`, `adhelm doctor`
+and every output that names a provider show the same label.
+
+| Provider | Label | Read in 0.1.0 | Setup |
+| --- | --- | --- | --- |
+| Google Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](docs/setup/google_ads.md) |
+| Meta Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](docs/setup/meta_ads.md) |
+| LinkedIn Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](docs/setup/linkedin_ads.md) |
+| TikTok Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](docs/setup/tiktok_ads.md) |
+| Reddit Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](docs/setup/reddit_ads.md) |
+| OpenAI Ads | `EXPERIMENTAL` | Account identity, campaign hierarchy, daily aggregate report, audit, recommendations | [setup](docs/setup/openai_ads.md) |
+| GA4 | `EXPERIMENTAL` | Data API aggregate reporting, read-only Admin inventory, audit | [setup](docs/setup/ga4.md) |
+| GTM | `EXPERIMENTAL` | Container inventory, dependency graph, read-only audit | [setup](docs/setup/gtm.md) |
+
+`doctor` expects GA4. GTM is optional, and a provider you have not configured
+does not block work on the others. Provider quotas, approvals and access tiers
+belong to the provider. You must obtain API access yourself, and a provider can
+change or withdraw its API.
+
+## What 0.1.0 does not do
+
+- **No remote writes.** Pausing, creating, activating, maintaining, GA4 Admin
+  edits and GTM staging, versioning and publishing are all refused with
+  `WRITES_NOT_RELEASED` (exit code `3`) before any credential-store access,
+  ledger `APPLY_STARTED` entry or network request. No configuration value,
+  environment variable, flag or edited file enables them. Offline compile, plan
+  and preview commands remain available and say that execution is unreleased.
+  When your agent recommends a change, you make it by hand in the provider's own
+  interface.
+- **No CRM attribution.** Salesforce and HubSpot are not part of `0.1.0`.
+- **`EXPERIMENTAL` providers have no live evidence.** Their reports and audits
+  are tested against fixtures, and their totals have not been compared with the
+  provider's own interface.
+- **Some reads are bounded, not exhaustive, and some are narrower than the
+  provider's API.** Where a provider documents no pagination, such as LinkedIn
+  analytics, audits say so instead of presenting the result as complete. The
+  [capability matrix](docs/capability-matrix.md) lists each provider's limits.
+- **Money is read in a few currencies only.** Google Ads, LinkedIn Ads, Reddit
+  Ads and OpenAI Ads project money exactly only for USD accounts. Meta Ads
+  accepts AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, MXN, NOK, NZD, SEK, SGD and USD.
+  TikTok Ads accepts AUD, CAD, EUR, GBP, JPY and USD. A read that carries money
+  for an account in any other currency is refused with `UNSUPPORTED_CURRENCY`
+  rather than converted approximately, so check your account currency before you
+  register an application.
+
+## Privacy and safety
+
+- The default runtime has no vendor proxy, hosted database, telemetry, crash
+  upload, automatic updater, or remote license heartbeat.
+- Interactive secrets live in the operating system credential store.
+  Environment variables are for explicitly configured CI use only.
+- Logs, plans, evidence and exports are local, redacted, deterministic and
+  user-initiated. Raw provider responses are not persisted by default.
+- Output your agent reads follows the same redaction rules, but your agent may
+  forward what it reads to its model. Share only what you are comfortable
+  sending there.
+- Each configured provider still receives the requests you make of it. Local
+  execution reduces vendor custody. It does not make you compliant with HIPAA,
+  GLBA or any other regime, and it does not replace legal, provider-policy or
+  security review.
+
+## Documentation
+
+- [0.1.0 release definition](docs/release-0.1.0.md) and
+  [ADR 0013](docs/adr/0013-open-source-release.md), which decide this release
+- [Product brief](docs/product-brief.md) and
+  [definition of done](docs/definition-of-done.md) for the `v1.0.0` target
+- [Bundled agent skills](docs/agent-skills.md)
+- [Capability matrix](docs/capability-matrix.md), the evidence level of every
+  provider operation
+- [Direct and delegated authorization](docs/authorization-policy.md)
+- [Reporting schema](docs/reporting-schema.md) and
+  [local history ledger and exports](docs/local-ledger-and-exports.md)
+- [Threat model](docs/threat-model.md) and [egress map](docs/egress-map.md)
+- [Architecture decisions](docs/adr/)
+- [AGENTS.md](AGENTS.md), the rules every contributor and agent follows
+
+## Contributing and security
+
+Contributions are welcome under the Developer Certificate of Origin; read
+[CONTRIBUTING.md](CONTRIBUTING.md). Report a vulnerability privately as
+[SECURITY.md](SECURITY.md) describes, never in a public issue. Participation is
+governed by the [Code of Conduct](CODE_OF_CONDUCT.md). Changes are recorded in
+the [changelog](CHANGELOG.md).
+
+## License
+
+AdHelm is licensed under the Apache License, Version 2.0; see the `LICENSE`
+file. The license does not grant rights to the AdHelm name or marks, and a fork
+that redistributes the software must not imply endorsement by this project.