oed-cli 0.2.0__tar.gz → 0.2.3__tar.gz

{oed_cli-0.2.0/src/oed_cli.egg-info → oed_cli-0.2.3}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: oed-cli
-Version: 0.2.0
+Version: 0.2.3
 Summary: oed — openEuler Infra command line. Auto-discovered, AI-friendly.
 Author: oed-cli contributors
 License: Apache-2.0
-Project-URL: Homepage, https://gitee.com/openeuler/oed-cli
-Project-URL: Documentation, https://gitee.com/openeuler/oed-cli/blob/master/docs/cli-design.md
-Project-URL: Bug Tracker, https://gitee.com/openeuler/oed-cli/issues
+Project-URL: Homepage, https://atomgit.com/openeuler/oed-cli
+Project-URL: Documentation, https://atomgit.com/openeuler/oed-cli/blob/master/docs/cli-design.md
+Project-URL: Bug Tracker, https://atomgit.com/openeuler/oed-cli/issues
 Keywords: openEuler,cli,discovery,ai-agent,openapi
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
@@ -60,7 +60,7 @@ only thing that has to be versioned is the gateway's OpenAPI spec itself.
 
 - **Zero boilerplate.** No copy-pasted OpenAPI clients, no per-service
   SDKs, no `--data` to escape, no `User-Agent` headers to remember.
-- **Runtime discovery.** The `oed cve-sa-backend --help` list you saw
+- **Runtime discovery.** The `oed cve --help` list you saw
   above is built from `https://api-gateway.osinfra.cn/discovery/apis` on
   every call. New services, new endpoints, and new schema fields show up
   without an `oed` upgrade. A 10-minute cache keeps CI bursts cheap;
@@ -90,14 +90,14 @@ pipx install oed-cli
 From source:
 
 ```bash
-git clone https://gitee.com/openeuler/oed-cli && cd oed-cli
+git clone https://atomgit.com/openeuler/oed-cli && cd oed-cli
 pip install -e .
 ```
 
 Verify:
 
 ```bash
-oed --version       # → oed, version 0.2.0
+oed --version       # → oed, version 0.2.3
 ```
 
 ---
@@ -106,8 +106,24 @@ oed --version       # → oed, version 0.2.0
 
 ```bash
 pip install oed-cli
-oed cve-sa-backend getSecurityNoticeByCveId --cve-id CVE-2019-10082
+oed cve getSecurityNoticeByCveId --cve-id CVE-2019-10082
 ```
+#### (optional) Call an AtomGit operation — store a token once
+
+Operations on the `ag` (AtomGit) service authenticate via an `access_token`
+query parameter. Store a personal access token once, and every `oed ag ...`
+call injects it automatically:
+
+```bash
+oed ag login
+```
+
+Then `oed ag listAuthenticatedUserIssues` just works — no per-call token
+flag needed. Full details (`oed ag login --token <pat> [--no-verify]`,
+`--status`, `oed ag logout`, how the token is stored, auto-injection rules)
+are in the [AtomGit (`ag`) authentication](#atomgit-ag-authentication)
+section below.
+
 
 That's it. `oed` discovers the service from the gateway, pulls its OpenAPI
 spec, derives `--cve-id` from the declared `query` parameter, fills WAF-safe
@@ -136,7 +152,7 @@ browser headers, and ships the request through the production gateway:
 Output is plain JSON on stdout — pipe straight into `jq`:
 
 ```bash
-oed cve-sa-backend getSecurityNoticeByCveId --cve-id CVE-2019-10082 \
+oed cve getSecurityNoticeByCveId --cve-id CVE-2019-10082 \
   | jq '.response.result[0] | {cveId, affectedProduct, affectedComponent}'
 ```
 
@@ -171,7 +187,7 @@ Don't guess. Each operation auto-derives its own flags from the OpenAPI
 schema:
 
 ```bash
-oed cve-sa-backend getSecurityNoticeByCveId --help
+oed cve getSecurityNoticeByCveId --help
 ```
 
 ```json
@@ -199,7 +215,7 @@ oed cve-sa-backend getSecurityNoticeByCveId --help
 Same idea at the service level — list every operation with one flag each:
 
 ```bash
-oed cve-sa-backend --help | jq '.operations | length'
+oed cve --help | jq '.operations | length'
 # → 37
 ```
 
@@ -209,33 +225,80 @@ oed cve-sa-backend --help | jq '.operations | length'
 
 ```bash
 # Dry-run — preview the request without hitting the network
-oed cve-sa-backend getSecurityNoticeByCveId --cve-id 1 --dry-run
+oed cve getSecurityNoticeByCveId --cve-id CVE-2019-10082 --dry-run
 
-# Path placeholder — `--id` is a path param, auto-substituted into the URL
-oed software-package-server getSoftwarePackage --id 12345 --language zh_CN
+# Date-filtered query — pagination comes back as total/page/size
+oed meeting listMeetings --date 2026-07-29
+# → response.data: [ { "topic": "安全sig例会", "group_name": "security-committee",
+#                     "date": "2026-07-29", "start": "16:00", "end": "18:00",
+#                     "join_url": "https://meeting.huaweicloud.com:36443/#/j/985661561", ... } ]
 
-# Integer / number flags auto-coerce from string
-oed software-package-server listSoftwarePackages --page-num 1 --count-per-page 5
+# Forum — Discourse `/latest.json`;
+oed forum listLatestTopics --per-page 2
+# → response.topic_list.topics: [ { "title": "《openEuler社区论坛使用指南&规则》",
+#                                   "posts_count": 12, "created_at": "2023-01-16T07:53:30.163Z" }, ... ]
 
-# POST with JSON body — Content-Type auto-set
-oed software-package-server applyNewSoftwarePackage \
-  --json '{"pkg_name":"demo","version":"1.0.0"}'
+# Search — POST JSON body; `keyword` + `lang` are required, pageSize must be 6-49
+oed search multisearchDocByKeyword \
+  --json '{"keyword":"软件源安装速度慢怎么办","lang":"zh","page":1,"pageSize":10}'
+# → response.obj.records: [ { "title": "<span>软件下载慢问题</span>",
+#                             "path": "https://eur.openeuler.openatom.cn/coprs/",
+#                             "type": "service", "lang": "zh" }, ... ]
 
-# Bulk JSON for scripts — `--params` is the escape hatch when you have many fields
-oed cve-sa-backend getSecurityNoticeByCveId --params '{"cveId":"1"}'
 
-# Raw OpenAPI spec, for debugging
-oed schema cve-sa-backend | jq '.paths | keys'
 ```
 
 ---
 
+## AtomGit (`ag`) authentication
+
+AtomGit operations authenticate through the `access_token` query parameter
+declared on their spec. Store a personal access token once, and every
+`oed ag ...` call uses it automatically:
+
+```bash
+# Interactive (prompts for the token, never echoes it back)
+oed ag login
+
+# Non-interactive — good for CI / scripts
+oed ag login --token <pat>
+
+# Skip validating the token against AtomGit before storing
+oed ag login --token <pat> --no-verify
+
+# Just report whether a token is configured (no network, no prompt)
+oed ag login --status
+
+# Forget the stored token
+oed ag logout
+```
+
+Token storage:
+
+- Windows: encrypted at rest for the current user via DPAPI (no extra deps).
+- Elsewhere: base64, which is documented obfuscation, **not** encryption.
+- Lives under the cache dir (`tokens/ag.json`); `oed cache clear` never
+  touches credentials.
+
+Auto-injection on real calls:
+
+- If the operation declares `access_token` and you don't pass one, the stored
+  token is filled in automatically — `oed ag listAuthenticatedUserIssues` just
+  works.
+- An explicit `--access-token <pat>` always wins over the stored one.
+- If the operation requires a token and none is available anywhere, you get a
+  clear `ag_token_missing` error with a hint, instead of an opaque gateway 401.
+- `--dry-run` and request echo views mask the token as `<stored>` — the real
+  value only ever goes out on the wire.
+
+---
+
 ## Local development
 
 ### Clone and install (editable)
 
 ```bash
-git clone https://gitee.com/openeuler/oed-cli && cd oed-cli
+git clone https://atomgit.com/openeuler/oed-cli && cd oed-cli
 pip install -e ".[dev]"
 ```
 
@@ -248,10 +311,11 @@ invocation. Drop it with `pip uninstall oed-cli` when you're done.
 python -m pytest -q
 ```
 
-41 tests cover v0.1 + v0.2 dispatch, the operation-help cheatsheet,
-per-parameter flag coercion, the `API_`-prefix alias, and every exit
-code path. They monkeypatch the discovery layer so no gateway access
-is needed.
+58 tests cover v0.1 + v0.2 dispatch, the operation-help cheatsheet,
+per-parameter flag coercion, the `API_`-prefix alias, the
+`resolve_runtime_gateway` no-fallback semantics, every exit code path, and
+v0.4's `ag` token store (DPAPI/base64) + auto-injection.
+They monkeypatch the discovery layer so no gateway access is needed.
 
 ### Smoke-test against the live gateway
 
@@ -261,13 +325,13 @@ oed info
 # → {"ok": true, "services_total": 8, "community": "openeuler", ...}
 
 # 2) Real CVE query (canonical end-to-end test)
-oed cve-sa-backend getSecurityNoticeByCveId --cve-id CVE-2019-10082
+oed cve getSecurityNoticeByCveId --cve-id CVE-2019-10082
 
 # 3) Dry-run to inspect URL + body without hitting the network
-oed cve-sa-backend getSecurityNoticeByCveId --cve-id 1 --dry-run
+oed cve getSecurityNoticeByCveId --cve-id 1 --dry-run
 
 # 4) Verify the canonical URL routing
-oed cve-sa-backend getSecurityNoticeByCveId --dry-run --cve-id 1 \
+oed cve getSecurityNoticeByCveId --dry-run --cve-id 1 \
   | jq '.url'
 # → "https://apig.osinfra.cn/cve-security-notice-server/securitynotice/getByCveId"
 ```
@@ -328,7 +392,10 @@ to eyeball `oed services` output every week.
 | `oed info` hangs or `waf_block` exit 2             | gateway unreachable / WAF      | confirm `curl https://api-gateway.osinfra.cn`; see `context/discoverAPI.md` §6 |
 | Chinese output garbled on Windows                  | console codepage not UTF-8     | `chcp 65001`, or pipe `\| python`, or `PYTHONIOENCODING=utf-8 oed …` |
 | `error="spec_missing"` (exit 4) on a known service | upstream hasn't published the spec yet | wait for the gateway-side OpenAPI yaml; nothing to do on the oed side |
-| A `cve-sa-backend` call exits 2 (`waf_block`)      | spec points to a `.test.osinfra.cn` host | already handled — oed routes via `apig.osinfra.cn` regardless of the spec's `x-apigateway-backend.httpEndpoints.address` |
+| `error="ag_token_missing"` on an `ag` call | operation needs a token, none stored | `oed ag login` (or pass `--access-token <pat>`) |
+| `error="body_fields_via_params"` (exit 1) on a POST | body fields were passed via `--params` (which only covers query/path) | resend the fields with `--json '{...}'` — `oed <service> <op> --help` lists the body schema |
+| `error="gateway_managed_param"` (exit 1) on a `forum` call | `Api-Key` / `Api-Username` were passed (`--api-key` or `--params`) | drop them — `oed` auto-fills both placeholder headers on every `forum` call and the gateway converts them |
+| A `cve` call exits 2 (`waf_block`)      | spec points to a `.test.osinfra.cn` host | already handled — `oed` reads `base_url` from the discovery feed (no fallback) and ignores the spec's `x-apigateway-backend.httpEndpoints.address` for the host |
 
 ### Offline mode
 
@@ -358,7 +425,7 @@ python -c "from oed_cli.main import main; sys.argv = ['oed','--help']; main()"
 ## Contributing
 
 Issues and patches welcome on
-[gitee.com/openeuler/oed-cli](https://gitee.com/openeuler/oed-cli).
+[atomgit.com/openeuler/oed-cli](https://atomgit.com/openeuler/oed-cli).
 
 Dev install: