xsync-cli 0.1.0__tar.gz → 0.1.2__tar.gz

{xsync_cli-0.1.0 → xsync_cli-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: xsync-cli
-Version: 0.1.0
+Version: 0.1.2
 Summary: Sync the model list of an OpenAI-compatible endpoint into the Codex model catalog.
 License-Expression: MIT
 License-File: LICENSE
@@ -77,7 +77,8 @@ Run this command again when the endpoint changes.
 | `xsync codex --profile <name>` | Use another profile for one run. |
 | `xsync codex --init` | Connect Codex to the endpoint of the profile. |
 | `xsync codex --reset` | Remove everything that xSync wrote. |
-| `xsync codex --reset --force` | Reset when no state file exists. |
+| `xsync codex --reset --force` | Reset when no state file exists. It asks first. |
+| `xsync codex --reset --force --yes` | Reset with no question. Use this in a script. |
 
 Exit codes: `0` for success, `1` for an error, `2` when the endpoint does not
 answer.
@@ -120,8 +121,21 @@ A profile uses `api_key` or `api_key_env`, but not both. Use `api_key_env`
 when you share the file. A profile with neither key sends no `Authorization`
 header.
 
-The `include` and `exclude` lists hold glob patterns. An empty `include`
-list keeps every model. The `exclude` list always wins.
+## The filters
+
+A glob pattern selects a model by name. The sign `*` means any characters.
+
+| Rule | Effect |
+|---|---|
+| `include = []` | Keep every model. This is the default. |
+| `include = ["cx/*", "ed3n/*"]` | Keep only the models of those two providers. |
+| `exclude = ["*embedding*"]` | Drop every model with `embedding` in the name. |
+| `exclude = ["*-image-*", "*-tts-*"]` | Drop the image models and the speech models. |
+
+The `exclude` list always wins over the `include` list. Use the filters when
+an endpoint serves many models that you never choose in Codex.
+
+The match ignores the letter case.
 
 ## Safety
 
@@ -136,9 +150,21 @@ list keeps every model. The `exclude` list always wins.
 - `--reset` removes only what the state file `~/.codex/.xsync-state.json`
   records. It never restores an old copy of `config.toml`, because Codex
   adds project entries to that file over time.
+- `--reset` keeps the catalog backup `<name>.bak`. The backup is the only
+  way back after a reset.
 - With no state file, `--reset` prints the keys that it would remove and
-  then stops. Add `--force` to continue.
-- xSync never prints an API key.
+  then stops. Add `--force` to continue. The command then asks a question
+  before it removes anything. Add `--yes` to answer the question in a
+  script.
+- The setup hides the API key while you type it. It then shows the first
+  five characters only, and it never shows the length of the key.
+- xSync never prints a whole API key.
+
+## The color
+
+xSync writes color for a terminal. It writes plain text for a pipe, for a
+dumb terminal, and when `NO_COLOR` holds a value. Set `FORCE_COLOR=1` to
+keep the color in a pipe.
 
 ## What xSync reads and what it writes
 

{xsync_cli-0.1.0 → xsync_cli-0.1.2}/README.md

@@ -65,7 +65,8 @@ Run this command again when the endpoint changes.
 | `xsync codex --profile <name>` | Use another profile for one run. |
 | `xsync codex --init` | Connect Codex to the endpoint of the profile. |
 | `xsync codex --reset` | Remove everything that xSync wrote. |
-| `xsync codex --reset --force` | Reset when no state file exists. |
+| `xsync codex --reset --force` | Reset when no state file exists. It asks first. |
+| `xsync codex --reset --force --yes` | Reset with no question. Use this in a script. |
 
 Exit codes: `0` for success, `1` for an error, `2` when the endpoint does not
 answer.
@@ -108,8 +109,21 @@ A profile uses `api_key` or `api_key_env`, but not both. Use `api_key_env`
 when you share the file. A profile with neither key sends no `Authorization`
 header.
 
-The `include` and `exclude` lists hold glob patterns. An empty `include`
-list keeps every model. The `exclude` list always wins.
+## The filters
+
+A glob pattern selects a model by name. The sign `*` means any characters.
+
+| Rule | Effect |
+|---|---|
+| `include = []` | Keep every model. This is the default. |
+| `include = ["cx/*", "ed3n/*"]` | Keep only the models of those two providers. |
+| `exclude = ["*embedding*"]` | Drop every model with `embedding` in the name. |
+| `exclude = ["*-image-*", "*-tts-*"]` | Drop the image models and the speech models. |
+
+The `exclude` list always wins over the `include` list. Use the filters when
+an endpoint serves many models that you never choose in Codex.
+
+The match ignores the letter case.
 
 ## Safety
 
@@ -124,9 +138,21 @@ list keeps every model. The `exclude` list always wins.
 - `--reset` removes only what the state file `~/.codex/.xsync-state.json`
   records. It never restores an old copy of `config.toml`, because Codex
   adds project entries to that file over time.
+- `--reset` keeps the catalog backup `<name>.bak`. The backup is the only
+  way back after a reset.
 - With no state file, `--reset` prints the keys that it would remove and
-  then stops. Add `--force` to continue.
-- xSync never prints an API key.
+  then stops. Add `--force` to continue. The command then asks a question
+  before it removes anything. Add `--yes` to answer the question in a
+  script.
+- The setup hides the API key while you type it. It then shows the first
+  five characters only, and it never shows the length of the key.
+- xSync never prints a whole API key.
+
+## The color
+
+xSync writes color for a terminal. It writes plain text for a pipe, for a
+dumb terminal, and when `NO_COLOR` holds a value. Set `FORCE_COLOR=1` to
+keep the color in a pipe.
 
 ## What xSync reads and what it writes
 

{xsync_cli-0.1.0 → xsync_cli-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "xsync-cli"
-version = "0.1.0"
+version = "0.1.2"
 description = "Sync the model list of an OpenAI-compatible endpoint into the Codex model catalog."
 readme = "README.md"
 requires-python = ">=3.11"

{xsync_cli-0.1.0 → xsync_cli-0.1.2}/src/xsync_cli/adapters/codex_config.py

@@ -68,6 +68,21 @@ def check_provider_match(config: dict[str, Any], profile: Profile) -> str | None
     return None
 
 
+def wire_api_for_url(config: dict[str, Any], base_url: str) -> str | None:
+    """The wire API that Codex already uses for one base URL.
+
+    The function gives None when no provider block holds that URL.
+    """
+    wanted = base_url.rstrip("/")
+    for table in (config.get("model_providers") or {}).values():
+        if not isinstance(table, dict):
+            continue
+        if str(table.get("base_url", "")).rstrip("/") == wanted:
+            value = table.get("wire_api")
+            return str(value) if value else None
+    return None
+
+
 def catalog_path_for(profile: Profile, codex_home: Path) -> Path:
     """The catalog file of one profile."""
     return codex_home / f"{profile.name}-models.json"

{xsync_cli-0.1.0 → xsync_cli-0.1.2}/src/xsync_cli/adapters/codex_wiring.py

@@ -103,7 +103,11 @@ def init_config(
 
 
 def reset_config(config_path: Path, state: State) -> list[str]:
-    """Remove every item that the state file records."""
+    """Remove every item that the state file records.
+
+    The function keeps the backup file `<name>.bak`. The backup is the
+    only way back after a reset.
+    """
     before = file_sha256(config_path)
     document = _load_document(config_path)
     removed: list[str] = []
@@ -129,9 +133,5 @@ def reset_config(config_path: Path, state: State) -> list[str]:
         if path.exists():
             path.unlink()
             removed.append(name)
-        backup = path.with_name(path.name + ".bak")
-        if backup.exists():
-            backup.unlink()
-            removed.append(str(backup))
 
     return removed