tripl 0.1.0__tar.gz

tripl-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/

tripl-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 2026 Vladislav Denisov
+
+   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.

tripl-0.1.0/PKG-INFO

@@ -0,0 +1,313 @@
+Metadata-Version: 2.4
+Name: tripl
+Version: 0.1.0
+Summary: Operator CLI for a tripl tracking-plan instance: diagnostics, health and live monitoring
+Project-URL: Homepage, https://vladenisov.github.io/tripl/
+Project-URL: Documentation, https://vladenisov.github.io/tripl/run/cli
+Project-URL: Repository, https://github.com/vladenisov/tripl
+Project-URL: Issues, https://github.com/vladenisov/tripl/issues
+Author: Vladislav Denisov
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: analytics,cli,devops,observability,tracking-plan,tripl
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx<1,>=0.27.0
+Description-Content-Type: text/markdown
+
+# tripl (CLI)
+
+Operator CLI for a **running tripl instance** — diagnostics, health and live
+monitoring. Like [`tripl-mcp`](../mcp-server), it is a pure HTTP client of the
+tripl REST API (`/api/v1`): it imports no backend code and never touches the
+database.
+
+The distribution is **`tripl`**, the console script is **`tripl`**, and the
+import package is **`tripl_cli`**. The last one is deliberate: the service's own
+source package is `backend/src/tripl/`, so a distribution that installed an
+importable `tripl` would shadow it in any environment holding both — a
+contributor's backend venv, for one. The service is packaged as the separate
+`tripl-server` distribution (tripl-ey6j.6), so `tripl` names this CLI alone.
+
+This package also owns the **shared async REST client** (`tripl_cli.client`) and
+the **shared request layer** above it (`tripl_cli.api`): every REST path, query
+parameter and response projection either surface uses is spelled once, here.
+`tripl-mcp` depends on `tripl` and imports both rather than carrying a copy, and
+a contract test in each package fails the build if a path literal appears
+anywhere else.
+
+## Install
+
+Python 3.12+; the only runtime dependency is `httpx`.
+
+> **Not on PyPI.** There is no `tripl` package on the index yet, so a bare
+> `uvx tripl` will not resolve. Install from git or from a checkout.
+
+From a local checkout — the form verified against this revision:
+
+```bash
+uv run --project /path/to/tripl/cli tripl --version
+# tripl 0.1.0
+```
+
+From git without a checkout. This package depends only on `httpx`, so it is
+expected to resolve (unlike `tripl-mcp`, which needs the unpublished `tripl`),
+but it is not exercised by CI:
+
+```bash
+uvx --from "git+https://github.com/vladenisov/tripl.git#subdirectory=cli" tripl --version
+```
+
+## Commands
+
+A command acting on the instance as a whole is one word; a command acting on a
+class of objects is `<plural-noun> <verb>`. Every verb takes `--json` and
+`--timeout SECONDS`; the ones that report on many projects also take
+`--project SLUG` (repeatable) and `--include-demo`. The ones that name a single
+object require `--project` **exactly once**. A bare `tripl scans` or
+`tripl drifts` prints that group's help on stderr and exits 2.
+
+```bash
+tripl doctor              # check the instance and report what is broken
+tripl doctor --json       # one JSON document on stdout, human lines on stderr
+tripl doctor --strict     # exit 3 on warnings too (never on skipped checks)
+tripl status              # projects, events, scans, signals, coverage
+tripl watch               # follow jobs, signals and delivery failures live
+tripl watch --json        # JSON Lines on stdout, one object per event
+tripl scans list          # scan configs, their schedule, and whether they dispatch
+tripl scans jobs <scan> --project SLUG      # recent jobs, newest first
+tripl scans run <scan> --project SLUG       # trigger a run now (WRITE)
+tripl scans cancel <scan> <job-id> --project SLUG   # cancel an active job (WRITE)
+tripl drifts list         # schema drifts; untriaged by default
+tripl drifts dismiss <drift-id> --project SLUG      # false_positive or snooze (WRITE)
+tripl install --app-url https://tripl.example.com --version 1.5.0   # provision a stack and start it (HOST)
+tripl install --app-url https://tripl.example.com --dry-run   # print the plan, write nothing
+tripl upgrade --to 1.6.0  # move an installed stack to a new image tag (HOST)
+```
+
+`--version` defaults to `latest`; pin a released tag in production so a re-run
+cannot move you onto an image you have not read the notes for. The command says
+so on stderr when you leave it at the default.
+
+`doctor`, `status`, `watch`, `scans list`, `scans jobs` and `drifts list` are
+**read-only** — a `tk_r_` key is enough. The three marked WRITE need a `tk_w_`
+key backed by an editor or owner, and the CLI does not pre-judge that: the key
+prefix is derived from the scope's first letter server-side and says nothing
+about the user's role, so the request is sent and the API's own 403 is printed.
+
+`scans cancel` and `drifts dismiss` prompt on a terminal and take `--yes`; when
+stdin is **not** a terminal and `--yes` was not given they refuse with exit 2
+rather than hanging a cron job or proceeding silently. `scans run` does not
+prompt and has no `--yes` at all — passing one is exit 2, because a no-op flag
+here is a flag a script author will assume works on the next command too. All
+three writes take `--dry-run`, which resolves everything, prints the exact
+request (method, path, params, body — never a credential) and sends nothing.
+
+`install` and `upgrade` are the two marked HOST: they act on a **directory and
+the local Docker daemon**, not on a running instance, so they take neither
+`--url` nor `--api-key` — passing either explicitly is exit 2 rather than a
+silently ignored flag. Both take `--dir` (default `./tripl`, always reported
+absolute), `--wait SECONDS` (default 300, `0` skips), `--dry-run`, `--yes` and
+`--json`, and both are idempotent: `install` re-run converges, and `upgrade` to
+the tag already pinned prints `already at X; nothing to do.` and exits 0.
+
+`install` writes `compose.yaml`, `infra/rabbitmq/rabbitmq.conf` and a generated
+**0600** `.env` into `--dir`, then runs `docker compose pull` and
+`docker compose up -d` in it and polls `<--app-url>/health`. It **never
+overwrites an existing `.env`**: that file is created, or appended to with your
+confirmation, or left alone. `--force` reaches `compose.yaml` and
+`rabbitmq.conf` only, and there is no flag that reaches `.env`, because losing
+`ENCRYPTION_KEY` permanently destroys every stored warehouse credential.
+`--no-start` writes the files and runs nothing (and skips the Docker probe
+entirely). Note that the health poll targets the **public** `--app-url`, so on a
+host whose TLS terminator is not up yet, use `--wait 0` and curl
+`http://127.0.0.1:8000/health` from the box.
+
+`upgrade --to` is required and a **downgrade is refused outright** with no
+override flag; an unorderable pair (`latest`, `sha-abc1234`, `1.4`) says so and
+demands `--yes`. It pulls, *then* moves the `TRIPL_VERSION` pin in `.env`
+keeping a 0600 `.env.bak.<UTC>` copy, *then* restarts — the pull is first so a
+bad tag leaves `.env` untouched. The `pg_dump` backup command is printed for
+**you** to run and always prompts: a dump this tool invoked and then called
+"your backup" would be a promise it cannot keep, not least because the dump does
+not contain `ENCRYPTION_KEY`. Your database lives in the named volume
+`pgdata18`, not in `--dir`.
+
+Neither creates the owner account, connects a warehouse or runs the first scan.
+The first two are unreachable with an API key of any scope — they need an
+interactive owner session — so `install` finishes by reading the instance's real
+bootstrap state from the unauthenticated `/auth/status` and printing the URL to
+open in a browser.
+
+`docker compose pull` and `up -d` write straight to your terminal and are never
+captured, so their progress and their errors are live; the exact invocation is
+printed first and is safe to paste. That is why `--json` carries the `argv`, the
+`cwd` and the `returncode` of each command rather than its output. No generated
+secret is ever printed — the document lists `secrets_generated` by **name**.
+
+Two operations are deliberately **not** offered here. A bounded metrics replay
+is owner-**session**-only server-side (`deps.get_owner_user` rejects every
+request carrying an API key scope), so no `tripl` command could reach it.
+Accepting a schema drift deletes the field definition on a `missing_field`
+drift — the damage `doctor`'s `schema_field_deleted_by_accept` finding exists to
+report — so that decision stays in the tripl UI.
+
+`doctor` runs six checks, always in this order and always exactly once each:
+`connectivity`, `auth`, `projects`, `data_sources`, `scans`, `drifts`.
+Per-project results are findings *inside* a check, so a consumer selects by
+`id` and gets one row.
+
+```text
+tripl doctor - https://tripl.example.com (from $TRIPL_BASE_URL)
+
+PASS  connectivity  Reached https://tripl.example.com (from $TRIPL_BASE_URL); the API and its database are up.
+PASS  auth          The API key authenticates as an instance-wide key (role: owner).
+PASS  projects      1 project selected.
+FAIL  data_sources  1 referenced data source(s); see below.
+      - fail: data_source_probe_failed 'warehouse-prod'
+        Data source 'warehouse-prod' (used by scan config 'prod events', 'checkout funnel') last failed its connection test at 2026-07-29T19:08:09Z: 'FATAL: password authentication failed for user "tripl"'.
+FAIL  scans         1 of 2 scheduled scan configs is not collecting.
+      - fail: scan_config_failing [prod] 'prod events'
+        Scan config 'prod events' (1h) has failed 5 consecutive scheduled runs since 2026-07-31T14:08:09Z. Last error: 'Scan failed due to an internal error.' - that is the backend's generic fallback, not the real cause, so the cause is in the worker log for job job-0.
+      - warn: scan_backoff_active [prod] 'prod events'
+        The scheduler has deliberately deferred the next attempt to not before 2026-07-31T22:08:09Z (about 4h after the last failure): 3 or more consecutive failures trigger a backoff, so the worker is not stuck.
+WARN  drifts        1 event type(s) examined; see below.
+      - warn: schema_field_deleted_by_accept [prod] 'app.screen_view'
+        Field 'user_id' was deleted from event type 'app.screen_view' on 2026-07-26T19:08:09Z when a missing_field drift was accepted (by user uid-7).
+      - warn: schema_drift_open [prod]
+        Project 'prod' has 1 untriaged schema drifts (oldest detected 2026-07-28T19:08:09Z): app.screen_view.cart_value (type_changed)
+
+6 checks: 3 pass, 1 warn, 2 fail. Exit 3.
+Re-run with --json for the machine-readable form of every finding.
+```
+
+Output is ASCII only and byte-identical whether stdout is a TTY or a pipe, so
+`tripl doctor | tee incident.log` and the terminal view are the same artifact.
+Two behaviours are worth knowing before you read a report: a **non-200 is never
+treated as an empty list** (it becomes `endpoint_unexpected_status`, because a
+404 read as "no drifts" is the class of mistake this tool exists to remove), and
+the scheduler's **retry backoff is reported as expected behaviour** rather than
+as a hang.
+
+`watch` answers the other question: not *what is broken* at one instant, but
+*what is happening right now*. It polls (there is no daemon and no subscription)
+and prints one line per change — a replay advancing a chunk, a job finishing, a
+signal opening, an alert delivery failing to page anyone. It **reaches no
+verdict**: a completed run exits 0 whatever it saw, and it never exits 3. The
+same ASCII-only, pipe-identical rule applies, so `tripl watch | tee
+incident.log` is the artifact you actually saw.
+
+```text
+2026-07-31T19:10:41Z  watch.started    1 project, 1 scan config, poll 10s.
+2026-07-31T19:10:51Z  job.progress     [prod] 'nightly replay' job job-91c2 chunk 4 of 18 (22.2%) collecting 2026-07-05T00:00:00Z..2026-07-06T00:00:00Z, 2m elapsed.
+2026-07-31T19:11:11Z  delivery.failed  [prod] 'Checkout drop' -> slack 'oncall' failed: 'channel_not_found'. Nobody was paged; delivery del-4f21.
+2026-07-31T19:11:21Z  watch.stopped    stopped (interrupted) after 40s, 5 ticks, 12 requests.
+```
+
+Useful flags beyond the shared three: `--scan NAME_OR_ID` (repeatable, exact
+match, narrows the job lines only), `--interval SECONDS` (default 10),
+`--duration SECONDS` (stop and exit 0; the default is to run until `Ctrl-C`) and
+`--stall-after SECONDS` (default 120, report a running job whose progress has
+not moved).
+
+| Exit | Meaning |
+|------|---------|
+| 0 | Every check passed, or only warned and `--strict` was not given. `status`, whenever it completed. `watch`, whenever the run completed — a failed job or a new signal is still 0. The `scans` / `drifts` verbs, whenever every read arrived or the write was accepted (`--dry-run` included). |
+| 1 | The tool itself broke (doctor turns every API failure into a finding), or any other command could not complete a request — unreachable, or the API refused it. For `watch` this includes a key revoked mid-run. For `scans list` / `drifts list` it includes **any** failed read in the fan-out; for `scans run`, a job returned already `failed`; for `scans cancel` / `drifts dismiss`, a declined prompt. |
+| 2 | Usage or configuration error. For `doctor` and `status` that is resolved before any socket opens; `watch` also refuses after reading the listings, when `--scan` matches nothing or more than 24 scan configs are selected. The `scans` / `drifts` verbs add a bare group, a missing or repeated `--project`, an unresolved or ambiguous `<scan>`, and a prompting write on a non-TTY without `--yes`. Either way **no JSON is emitted** and no write is sent. |
+| 3 | `doctor` only: at least one check failed, or `--strict` and at least one warning. Nothing else ever exits 3. |
+| 130 | Interrupted (SIGINT). For `watch` this is the **normal** ending — a run without `--duration` has no other way to stop. |
+
+An unreachable instance therefore exits **3** out of `doctor`, not 1 — it
+becomes a finding like everything else doctor reads, which is what makes an exit
+1 out of `doctor` a meaningful bug signal. **Every other command exits 1** on an
+unreachable instance, because none of them turns a failed read into a verdict.
+
+`doctor` and `status` put exactly one JSON document on stdout, and so do the
+`scans` / `drifts` verbs — but only when the command completes: a write the API
+refused, a read that failed outright and a declined prompt all leave stdout
+**empty** and put the reason on stderr, so a consumer checks the exit code
+before it parses. `watch --json`
+puts **JSON Lines**, one object per event, flushed as produced. Within one
+`schema_version`, key names are never removed or retyped, and check `id`s,
+finding `code`s, `status`/`severity` values and `watch` event tokens are never
+renamed or repurposed. New keys, ids, codes and tokens may appear in any
+release. `title`, `summary` and `message` are prose. **Assert on `code` and
+`evidence` — or, for `watch`, on `event` and `data` — never on prose.**
+
+Full reference — every check, every finding code with its `evidence` keys, every
+`watch` event token and the JSON Lines envelope, and what an operator should
+actually do about each one:
+<https://vladenisov.github.io/tripl/run/cli> (source:
+[`website/docs/run/cli.md`](../website/docs/run/cli.md)).
+
+## Configuration
+
+Resolved **per field**, highest precedence first:
+
+1. command-line flag — `--url` / `--base-url`, `--api-key`
+2. environment — `TRIPL_BASE_URL`, `TRIPL_API_KEY`
+3. config file — `base_url`, `api_key`
+
+Per field, not per source: `--url https://staging` with the key still coming
+from the config file works.
+
+| Variable | Meaning |
+|----------|---------|
+| `TRIPL_BASE_URL` | Base URL of the tripl instance (the same variable `tripl-mcp` reads) |
+| `TRIPL_API_KEY` | API key — `tk_r_` for read-only, `tk_w_` for write |
+| `XDG_CONFIG_HOME` | Overrides the config file location on every platform |
+
+There is deliberately **no `TRIPL_URL`**: two supported spellings for one
+setting is how configuration drifts. If it is set and `TRIPL_BASE_URL` is not,
+the error says so by name.
+
+### Config file
+
+| Platform | Path |
+|----------|------|
+| Linux / BSD / macOS | `$XDG_CONFIG_HOME/tripl/config.toml`, else `~/.config/tripl/config.toml` |
+| Windows | `%APPDATA%\tripl\config.toml`, else the `~/.config` fallback |
+
+```toml
+# ~/.config/tripl/config.toml
+base_url = "https://tripl.example.com"
+api_key  = "tk_r_..."
+```
+
+TOML because `tomllib` is stdlib on the supported Pythons, so the file format
+costs **zero runtime dependencies** — which matters, because `tripl-mcp`
+inherits every dependency of this package. Unknown keys and unknown tables are
+ignored, so an older CLI keeps working against a file written by a newer one.
+
+`--config PATH` overrides discovery. A missing *default* file is fine; a missing
+`--config` path is an error. On POSIX, a config file that holds an `api_key` and
+is readable by other users gets one warning on stderr — `chmod 600` it.
+
+Create API keys in the tripl app under **Settings → API keys**.
+
+## Development
+
+```bash
+cd cli
+uv sync
+uv run --group dev pytest -q
+uv run --group dev ruff check
+uv run --group dev ruff format --check
+uv run --group dev mypy src
+```
+
+`mcp-server` resolves this package from `../cli` via `[tool.uv.sources]` while
+it is unpublished, so a change here is picked up by `cd mcp-server && uv sync`
+without any install step. Run **both** suites after touching `client.py`.