Every settings field declares its tier; a value in the wrong file is an error naming
file, key and tier. A field naming a program or affecting a gate cannot be declared
instance. Secrets are references only: {"ref": "<name>"} via WIKITOOL_SECRET_<NAME> or
a user-only secrets file, {"ref": "op://..."} via op read (locked 1Password: exit 42).
The preflight records op as an optional tool. doctor gains one line per tier, docs
verify checks a committed wikitool.json for plaintext secrets, CI resolves a real
op:// value through 1password/load-secrets-action. No feature reads its settings
this way yet; without the two files every other command is unchanged.
Files changed:
- .gitea/workflows/ci.yml
- .gitignore
- AGENTS.md
- CHANGES.md
- INSTALL.md
- VERSION
- docs/explanation/README.md
- docs/explanation/configuration-tiers.md
- docs/how-to/README.md
- docs/how-to/use-1password-for-settings.md
- docs/reference/commands/README.md
- docs/reference/commands/configuration.md
- docs/reference/commands/instance-health.md
- docs/reference/commands/types-instructions-and-docs.md
- docs/reference/configuration.md
- docs/reference/exit-codes.md
- instructions/dev/doc-pull-through.md
- instructions/dev/testing-conventions.md
- instructions/preflight.md
- tools/CONTRACT.md
- tools/README.md
- tools/chemenu/cli.py
- tools/chemenu/cli_contract.py
- tools/chemenu/commands/_util.py
- tools/chemenu/commands/config_cmd.py
- tools/chemenu/commands/docs_verify.py
- tools/chemenu/commands/doctor.py
- tools/chemenu/config.py
- tools/chemenu/config_shapes.py
- tools/chemenu/prerequisites.py
- tools/chemenu/settings.py
- tools/chemenu/tests/conftest.py
- tools/chemenu/tests/test_dist_cmd.py
- tools/chemenu/tests/test_preflight.py
- tools/chemenu/tests/test_preflight_pwsh.py
- tools/chemenu/tests/test_settings.py
- tools/chemenu/toolpaths.py
- tools/preflight.ps1
- tools/preflight.sh
- tools/prerequisites.txt
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
2.6 KiB
2.6 KiB
Configuration
Writing the tiered settings in wikitool.json and .wikitool-local.json.
config set
Set one value of the tiered settings, in the file its tier names.
Synopsis
wikitool config set <section>.<field> <value>wikitool config set <section>.<field> --ref <name|op://vault/item/field>
Options
Arguments:
key <section>.<field> [required]
value The plain value; a string as given, anything else as JSON.
Options:
--ref <str> A reference instead of a value: <name> or
op://<vault>/<item>/<field>.
-h, --help Show this message and exit.
Examples
tools/wikitool config set tracker.stale_days 14
tools/wikitool config set tracker.token --ref tracker_token
tools/wikitool config set tracker.url --ref op://Chemenu/tracker/url
Behaviour
- Writes a plain value of a field of tier
instanceintowikitool.json, and one of tiercheckout- a private field's included - into.wikitool-local.json. - With
--ref, writes a reference instead of a value intowikitool.json:<name>resolves throughWIKITOOL_SECRET_<NAME>, then the secrets file in the user's configuration directory;op://<vault>/<item>/<field>resolves through the 1Password CLI. Only a secret or private field takes one. - Removes the same key from the other file, so a value never has two places, and says so.
- Creates
wikitool.jsonwith a freshinstance_idthe first time it writes anything; the secrets file is found by that id. - Checks both files as they would stand after the write against every registered section, and writes nothing when that fails.
- Prints the key and the file it wrote, never the value. Resolves no reference.
Properties
- Changes files: yes
- Idempotent: yes
- Atomic: Each file is replaced in one rename; both are checked before either is written
- Counts toward the session call budget: yes
- Can reach the network: no
Exit codes
0- success1- The key names no registered section or field, or is not<section>.<field>1- A plain value given for a field of tiersecret1---refgiven for a field that takes a plain value, or a malformed reference1- The value is not of the field's type, or the files would not pass their check afterwards42- The field names a program to run or affects a gate
See also
wikitool doctor- whether both files pass and every reference resolvesdocs/reference/configuration.md- the files, the tiers and the referencesdocs/how-to/use-1password-for-settings.md- setting 1Password up as the source