qor-harness 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. qor_harness-0.1.0/.gitignore +6 -0
  2. qor_harness-0.1.0/LICENSE +203 -0
  3. qor_harness-0.1.0/PKG-INFO +136 -0
  4. qor_harness-0.1.0/pyproject.toml +36 -0
  5. qor_harness-0.1.0/release/README.md +125 -0
  6. qor_harness-0.1.0/release/docs/headless.md +36 -0
  7. qor_harness-0.1.0/release/docs/models.md +45 -0
  8. qor_harness-0.1.0/src/qor/__init__.py +3 -0
  9. qor_harness-0.1.0/src/qor/__main__.py +3 -0
  10. qor_harness-0.1.0/src/qor/cli.py +109 -0
  11. qor_harness-0.1.0/src/qor/config.py +271 -0
  12. qor_harness-0.1.0/src/qor/core/__init__.py +1 -0
  13. qor_harness-0.1.0/src/qor/core/compaction.py +140 -0
  14. qor_harness-0.1.0/src/qor/core/context.py +35 -0
  15. qor_harness-0.1.0/src/qor/core/context_records.py +38 -0
  16. qor_harness-0.1.0/src/qor/core/events.py +123 -0
  17. qor_harness-0.1.0/src/qor/core/messages.py +111 -0
  18. qor_harness-0.1.0/src/qor/core/runtime.py +530 -0
  19. qor_harness-0.1.0/src/qor/core/strict.py +53 -0
  20. qor_harness-0.1.0/src/qor/core/types.py +36 -0
  21. qor_harness-0.1.0/src/qor/core/usage.py +87 -0
  22. qor_harness-0.1.0/src/qor/headless.py +46 -0
  23. qor_harness-0.1.0/src/qor/live.py +410 -0
  24. qor_harness-0.1.0/src/qor/model_setup.py +159 -0
  25. qor_harness-0.1.0/src/qor/models.py +225 -0
  26. qor_harness-0.1.0/src/qor/plugins/__init__.py +60 -0
  27. qor_harness-0.1.0/src/qor/plugins/patch/__init__.py +37 -0
  28. qor_harness-0.1.0/src/qor/plugins/patch/format.py +286 -0
  29. qor_harness-0.1.0/src/qor/providers/__init__.py +1 -0
  30. qor_harness-0.1.0/src/qor/providers/auth.py +49 -0
  31. qor_harness-0.1.0/src/qor/providers/base.py +25 -0
  32. qor_harness-0.1.0/src/qor/providers/discovery.py +54 -0
  33. qor_harness-0.1.0/src/qor/providers/openai.py +300 -0
  34. qor_harness-0.1.0/src/qor/providers/pricing.py +90 -0
  35. qor_harness-0.1.0/src/qor/sessions.py +369 -0
  36. qor_harness-0.1.0/src/qor/tools/__init__.py +1 -0
  37. qor_harness-0.1.0/src/qor/tools/files.py +499 -0
  38. qor_harness-0.1.0/src/qor/tools/matching.py +81 -0
  39. qor_harness-0.1.0/src/qor/tools/process.py +291 -0
  40. qor_harness-0.1.0/src/qor/tools/registry.py +176 -0
  41. qor_harness-0.1.0/src/qor/tools/replace.py +244 -0
  42. qor_harness-0.1.0/src/qor/tui/__init__.py +1 -0
  43. qor_harness-0.1.0/src/qor/tui/app.py +757 -0
  44. qor_harness-0.1.0/src/qor/tui/commands.py +66 -0
  45. qor_harness-0.1.0/src/qor/tui/intro.py +215 -0
  46. qor_harness-0.1.0/src/qor/tui/qor_logo.ans +14 -0
  47. qor_harness-0.1.0/src/qor/tui/state.py +259 -0
  48. qor_harness-0.1.0/src/qor/tui/theme.tcss +93 -0
  49. qor_harness-0.1.0/src/qor/tui/widgets.py +609 -0
@@ -0,0 +1,6 @@
1
+ .venv/
2
+ __pycache__/
3
+ .pytest_cache/
4
+ *.py[cod]
5
+ dist/
6
+ *.egg-info/
@@ -0,0 +1,203 @@
1
+ Copyright 2026 Gunnar Leffler
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,136 @@
1
+ Metadata-Version: 2.5
2
+ Name: qor-harness
3
+ Version: 0.1.0
4
+ Summary: Ϙ A TUI-first Python agent harness
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Requires-Python: >=3.12
8
+ Requires-Dist: httpx<1,>=0.28
9
+ Requires-Dist: textual<9,>=8.0
10
+ Description-Content-Type: text/markdown
11
+
12
+ # Ϙ qor harness
13
+
14
+ **Strap In!**
15
+
16
+ Version 0.1.0 · 2026-11-15
17
+
18
+ qor harness (pronounced “core harness”) is a keyboard-first agent harness for working with
19
+ projects from your terminal. It connects to an OpenAI-compatible model endpoint
20
+ and gives the model tools to read and edit files and run commands.
21
+
22
+ Use the interactive terminal interface for a conversation, or run a single
23
+ prompt from the command line. qor can also work in chat-only mode without
24
+ workspace tools.
25
+
26
+ ## Requirements
27
+
28
+ - Python 3.12 or newer.
29
+ - An accessible OpenAI-compatible streaming chat endpoint and a model available
30
+ on that endpoint. qor does not download models or install a model server.
31
+ - A terminal for interactive setup and the terminal interface.
32
+
33
+ ## Install
34
+
35
+ From an unpacked source distribution, use [uv](https://docs.astral.sh/uv/) or
36
+ [pipx](https://pipx.pypa.io/):
37
+
38
+ ```sh
39
+ uv tool install .
40
+ # or: pipx install .
41
+ ```
42
+
43
+ You can also install into an active virtual environment with `pip install .`.
44
+ The PyPI distribution is not yet published.
45
+ To install a built wheel directly, run `pipx install /path/to/qor_harness-0.1.0-py3-none-any.whl`.
46
+
47
+ ## Get started
48
+
49
+ Start in the project directory:
50
+
51
+ ```sh
52
+ qor
53
+ ```
54
+
55
+ If no model is configured, qor guides you through registering models from an
56
+ endpoint and choosing a default. To use an already installed Ollama model
57
+ without guided setup, for example:
58
+
59
+ ```sh
60
+ qor --model gpt-oss:20b
61
+ ```
62
+
63
+ Replace the model name with one available on your server. The default API root
64
+ is `http://127.0.0.1:11434/v1`; use `--base-url` to choose another endpoint.
65
+ Run `qor models` to list registered models, or `qor models add` to discover
66
+ models from an endpoint. qor does not automatically import another tool's
67
+ settings or credentials.
68
+
69
+ By default, the workspace is the directory where you start qor. Use
70
+ `--workspace /path/to/project` to choose another directory. In coding mode,
71
+ qor loads the workspace-root `AGENTS.md`, if present, as project guidance.
72
+
73
+ ## Tools and safety
74
+
75
+ **Trusted mode is the default.** The model can read and edit files and run shell
76
+ commands without routine approval. Commands run with your OS permissions; Bash
77
+ is not sandboxed. Run qor only with models, endpoints and projects you trust.
78
+
79
+ - Start with `qor --review` to review edits and commands before they run in the
80
+ terminal interface.
81
+ - Start with `qor --chat` for chat-only mode without workspace tools.
82
+ - Use `/chat` and `/coding` while idle to switch modes without losing the
83
+ conversation.
84
+
85
+ Review mode does not approve operations in headless runs: operations that need
86
+ approval are denied instead.
87
+
88
+ ## In the terminal
89
+
90
+ Type a message and press Enter. Use Alt+Enter or Ctrl+J for a newline. Type `/`
91
+ to see local commands. A few useful ones:
92
+
93
+ | Command | Action |
94
+ | --- | --- |
95
+ | `/help` | Show keys and commands. |
96
+ | `/model` | Choose a registered model. |
97
+ | `/providers` | Manage providers and discover models. |
98
+ | `/new` | Start a new session. |
99
+ | `/resume` | Continue a saved session for this workspace. |
100
+ | `/compact` | Summarise older conversation history. |
101
+ | `/quit` | Exit qor. |
102
+
103
+ Use Ctrl+C to cancel a run. During a run, you can send another message to steer
104
+ the next response after the current tool batch.
105
+
106
+ ## Run one prompt
107
+
108
+ Configure a model first using the terminal interface or `qor models add`. Then:
109
+
110
+ ```sh
111
+ qor --chat run "Explain this project"
112
+ qor --workspace /path/to/project run --jsonl "Inspect the failing test"
113
+ ```
114
+
115
+ Without `--jsonl`, a headless run prints the final reply. With it, qor streams
116
+ runtime events as JSON lines. Put shared options such as `--chat`, `--review`
117
+ and `--workspace` before `run`; put `--jsonl` after it. Run `qor --help` and
118
+ `qor run --help` for the available options.
119
+ The source distribution also includes model setup and headless guides in `release/docs/`.
120
+
121
+ ## Sessions and context
122
+
123
+ qor stores settings and model registrations under
124
+ `${XDG_CONFIG_HOME:-$HOME/.config}/qor/` and session journals under
125
+ `${XDG_STATE_HOME:-$HOME/.local/state}/qor/sessions/`. Original journal entries
126
+ remain when older conversation history is compacted. Set an accurate model
127
+ context window with `/model edit` to use automatic compaction effectively.
128
+
129
+ A resumed session restores completed runs; an interrupted run does not rerun
130
+ its tools. Chat or coding mode is not saved with a session.
131
+
132
+ ## License
133
+
134
+ Apache License 2.0.
135
+
136
+ Copyright © 2026 Gunnar Leffler.
@@ -0,0 +1,36 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "qor-harness"
7
+ version = "0.1.0"
8
+ description = "Ϙ A TUI-first Python agent harness"
9
+ readme = "release/README.md"
10
+ requires-python = ">=3.12"
11
+ license = "Apache-2.0"
12
+ dependencies = ["textual>=8.0,<9", "httpx>=0.28,<1"]
13
+
14
+ [project.scripts]
15
+ qor = "qor.cli:main"
16
+
17
+ [dependency-groups]
18
+ dev = [
19
+ "pytest>=8,<10",
20
+ "pytest-asyncio>=1,<2",
21
+ "pytest-xdist>=3,<4",
22
+ ]
23
+
24
+ [tool.pytest.ini_options]
25
+ asyncio_mode = "auto"
26
+ asyncio_default_fixture_loop_scope = "function"
27
+ testpaths = ["tests"]
28
+ pythonpath = ["tests"]
29
+ # Parallel by default. tests/conftest.py makes "auto" half the CPU threads. Use -n 0 for one process.
30
+ addopts = "-n auto"
31
+
32
+ [tool.hatch.build.targets.wheel]
33
+ packages = ["src/qor"]
34
+
35
+ [tool.hatch.build.targets.sdist]
36
+ only-include = ["src/qor", "release", "LICENSE", "pyproject.toml"]
@@ -0,0 +1,125 @@
1
+ # Ϙ qor harness
2
+
3
+ **Strap In!**
4
+
5
+ Version 0.1.0 · 2026-11-15
6
+
7
+ qor harness (pronounced “core harness”) is a keyboard-first agent harness for working with
8
+ projects from your terminal. It connects to an OpenAI-compatible model endpoint
9
+ and gives the model tools to read and edit files and run commands.
10
+
11
+ Use the interactive terminal interface for a conversation, or run a single
12
+ prompt from the command line. qor can also work in chat-only mode without
13
+ workspace tools.
14
+
15
+ ## Requirements
16
+
17
+ - Python 3.12 or newer.
18
+ - An accessible OpenAI-compatible streaming chat endpoint and a model available
19
+ on that endpoint. qor does not download models or install a model server.
20
+ - A terminal for interactive setup and the terminal interface.
21
+
22
+ ## Install
23
+
24
+ From an unpacked source distribution, use [uv](https://docs.astral.sh/uv/) or
25
+ [pipx](https://pipx.pypa.io/):
26
+
27
+ ```sh
28
+ uv tool install .
29
+ # or: pipx install .
30
+ ```
31
+
32
+ You can also install into an active virtual environment with `pip install .`.
33
+ The PyPI distribution is not yet published.
34
+ To install a built wheel directly, run `pipx install /path/to/qor_harness-0.1.0-py3-none-any.whl`.
35
+
36
+ ## Get started
37
+
38
+ Start in the project directory:
39
+
40
+ ```sh
41
+ qor
42
+ ```
43
+
44
+ If no model is configured, qor guides you through registering models from an
45
+ endpoint and choosing a default. To use an already installed Ollama model
46
+ without guided setup, for example:
47
+
48
+ ```sh
49
+ qor --model gpt-oss:20b
50
+ ```
51
+
52
+ Replace the model name with one available on your server. The default API root
53
+ is `http://127.0.0.1:11434/v1`; use `--base-url` to choose another endpoint.
54
+ Run `qor models` to list registered models, or `qor models add` to discover
55
+ models from an endpoint. qor does not automatically import another tool's
56
+ settings or credentials.
57
+
58
+ By default, the workspace is the directory where you start qor. Use
59
+ `--workspace /path/to/project` to choose another directory. In coding mode,
60
+ qor loads the workspace-root `AGENTS.md`, if present, as project guidance.
61
+
62
+ ## Tools and safety
63
+
64
+ **Trusted mode is the default.** The model can read and edit files and run shell
65
+ commands without routine approval. Commands run with your OS permissions; Bash
66
+ is not sandboxed. Run qor only with models, endpoints and projects you trust.
67
+
68
+ - Start with `qor --review` to review edits and commands before they run in the
69
+ terminal interface.
70
+ - Start with `qor --chat` for chat-only mode without workspace tools.
71
+ - Use `/chat` and `/coding` while idle to switch modes without losing the
72
+ conversation.
73
+
74
+ Review mode does not approve operations in headless runs: operations that need
75
+ approval are denied instead.
76
+
77
+ ## In the terminal
78
+
79
+ Type a message and press Enter. Use Alt+Enter or Ctrl+J for a newline. Type `/`
80
+ to see local commands. A few useful ones:
81
+
82
+ | Command | Action |
83
+ | --- | --- |
84
+ | `/help` | Show keys and commands. |
85
+ | `/model` | Choose a registered model. |
86
+ | `/providers` | Manage providers and discover models. |
87
+ | `/new` | Start a new session. |
88
+ | `/resume` | Continue a saved session for this workspace. |
89
+ | `/compact` | Summarise older conversation history. |
90
+ | `/quit` | Exit qor. |
91
+
92
+ Use Ctrl+C to cancel a run. During a run, you can send another message to steer
93
+ the next response after the current tool batch.
94
+
95
+ ## Run one prompt
96
+
97
+ Configure a model first using the terminal interface or `qor models add`. Then:
98
+
99
+ ```sh
100
+ qor --chat run "Explain this project"
101
+ qor --workspace /path/to/project run --jsonl "Inspect the failing test"
102
+ ```
103
+
104
+ Without `--jsonl`, a headless run prints the final reply. With it, qor streams
105
+ runtime events as JSON lines. Put shared options such as `--chat`, `--review`
106
+ and `--workspace` before `run`; put `--jsonl` after it. Run `qor --help` and
107
+ `qor run --help` for the available options.
108
+ The source distribution also includes model setup and headless guides in `release/docs/`.
109
+
110
+ ## Sessions and context
111
+
112
+ qor stores settings and model registrations under
113
+ `${XDG_CONFIG_HOME:-$HOME/.config}/qor/` and session journals under
114
+ `${XDG_STATE_HOME:-$HOME/.local/state}/qor/sessions/`. Original journal entries
115
+ remain when older conversation history is compacted. Set an accurate model
116
+ context window with `/model edit` to use automatic compaction effectively.
117
+
118
+ A resumed session restores completed runs; an interrupted run does not rerun
119
+ its tools. Chat or coding mode is not saved with a session.
120
+
121
+ ## License
122
+
123
+ Apache License 2.0.
124
+
125
+ Copyright © 2026 Gunnar Leffler.
@@ -0,0 +1,36 @@
1
+ # Headless runs
2
+
3
+ Run a single prompt without opening the terminal interface:
4
+
5
+ ```sh
6
+ qor --chat run "Explain this project"
7
+ qor --workspace /path/to/project run --jsonl "Inspect the failing test"
8
+ ```
9
+
10
+ Configure a model first with `qor` or `qor models add`. Headless runs do not
11
+ open setup dialogs. Each invocation starts a new session; use `/resume` in the
12
+ terminal interface to inspect or continue it in the same workspace.
13
+
14
+ Put shared options such as `--model`, `--workspace`, `--chat` and `--review`
15
+ before `run`, and `--jsonl` after it. A prompt is required. For a prompt that
16
+ starts with a hyphen, use `run -- "-your prompt"`.
17
+
18
+ Text mode prints the final assistant reply to stdout and diagnostics to stderr.
19
+ JSONL mode streams versioned runtime events, including tool proposals and
20
+ results and any provider-streamed thinking. Treat captured output as project
21
+ data.
22
+
23
+ Trusted mode runs tools without routine approval, just as in the terminal
24
+ interface. In headless `--review` mode, operations that need approval are denied;
25
+ no approval dialog opens. A completed run with a denial exits with code 3.
26
+
27
+ | Exit code | Meaning |
28
+ | --- | --- |
29
+ | 0 | Run finished; inspect the reply to determine whether the task succeeded. |
30
+ | 1 | Runtime, provider or session-storage failure. |
31
+ | 2 | Invalid arguments, configuration, workspace or prompt. |
32
+ | 3 | Run finished after an approval denial. |
33
+ | 130 | Interrupted or cancelled. |
34
+
35
+ Failure and cancellation take precedence over approval denial. Cancelling does
36
+ not undo file changes or commands that have already run.
@@ -0,0 +1,45 @@
1
+ # Models and providers
2
+
3
+ qor connects to OpenAI-compatible streaming chat endpoints. You need a running
4
+ endpoint and a model available on it; qor does not install either one.
5
+
6
+ Run `qor` in a terminal for guided setup, or run `qor models add` to register
7
+ models from an endpoint. Discovery requests the endpoint's `/models` listing;
8
+ it does not test inference or discover model capabilities. Run `qor models`
9
+ to list registered models and `qor models default` to choose the default.
10
+
11
+ For a single launch, `qor --model MODEL --base-url URL` selects a model and API
12
+ root. The default root is `http://127.0.0.1:11434/v1` for a local Ollama server.
13
+ Use `/model` to switch registered models in the terminal interface and
14
+ `/providers` to manage endpoints.
15
+
16
+ ## Authentication
17
+
18
+ For a provider using Bearer authentication, keep the key in an environment
19
+ variable and register its name rather than the key itself:
20
+
21
+ ```sh
22
+ export PROVIDER_API_KEY='your-key'
23
+ qor models add --provider example --base-url https://models.example.com/v1 \
24
+ --api-key-env PROVIDER_API_KEY
25
+ ```
26
+
27
+ For a custom header, use `--header 'X-Token=$PROVIDER_API_KEY'`. The quotes
28
+ prevent the shell from expanding the secret in the command. References are
29
+ resolved when qor makes requests. Prefer HTTPS for remote endpoints: HTTP does
30
+ not encrypt credentials.
31
+
32
+ The catalog is stored in `${XDG_CONFIG_HOME:-$HOME/.config}/qor/models.json`.
33
+ Literal credentials in that file are not encrypted. qor does not automatically
34
+ import credentials from other tools.
35
+
36
+ ## Context and reasoning
37
+
38
+ Use `/model edit` to set a model's context window. An accurate window lets qor
39
+ estimate when to compact older conversation history. Compaction leaves original
40
+ journal entries intact.
41
+
42
+ `/thinking` offers reasoning levels only when the model's catalog entry declares
43
+ supported levels. Discovery does not infer them. Not every OpenAI-compatible
44
+ server supports the same options; configure only capabilities your endpoint
45
+ and model actually support.
@@ -0,0 +1,3 @@
1
+ """Ϙ qor: a Python agent harness."""
2
+
3
+ __version__ = "0.1.0"
@@ -0,0 +1,3 @@
1
+ from qor.cli import main
2
+
3
+ raise SystemExit(main())