soothe 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 (98) hide show
  1. soothe-0.1.0/.gitignore +211 -0
  2. soothe-0.1.0/LICENSE +21 -0
  3. soothe-0.1.0/PKG-INFO +304 -0
  4. soothe-0.1.0/README.md +213 -0
  5. soothe-0.1.0/pyproject.toml +169 -0
  6. soothe-0.1.0/soothe/__init__.py +48 -0
  7. soothe-0.1.0/soothe/backends/__init__.py +1 -0
  8. soothe-0.1.0/soothe/backends/context/__init__.py +5 -0
  9. soothe-0.1.0/soothe/backends/context/keyword.py +141 -0
  10. soothe-0.1.0/soothe/backends/context/vector.py +142 -0
  11. soothe-0.1.0/soothe/backends/durability/__init__.py +6 -0
  12. soothe-0.1.0/soothe/backends/durability/in_memory.py +89 -0
  13. soothe-0.1.0/soothe/backends/durability/langgraph.py +118 -0
  14. soothe-0.1.0/soothe/backends/memory/__init__.py +5 -0
  15. soothe-0.1.0/soothe/backends/memory/store.py +111 -0
  16. soothe-0.1.0/soothe/backends/memory/vector.py +116 -0
  17. soothe-0.1.0/soothe/backends/persistence/__init__.py +71 -0
  18. soothe-0.1.0/soothe/backends/persistence/json_store.py +55 -0
  19. soothe-0.1.0/soothe/backends/persistence/rocksdb_store.py +60 -0
  20. soothe-0.1.0/soothe/backends/planning/__init__.py +5 -0
  21. soothe-0.1.0/soothe/backends/planning/claude.py +182 -0
  22. soothe-0.1.0/soothe/backends/planning/direct.py +101 -0
  23. soothe-0.1.0/soothe/backends/planning/router.py +200 -0
  24. soothe-0.1.0/soothe/backends/planning/subagent.py +157 -0
  25. soothe-0.1.0/soothe/backends/policy/__init__.py +5 -0
  26. soothe-0.1.0/soothe/backends/policy/config_driven.py +182 -0
  27. soothe-0.1.0/soothe/backends/remote/__init__.py +5 -0
  28. soothe-0.1.0/soothe/backends/remote/langgraph.py +60 -0
  29. soothe-0.1.0/soothe/backends/vector_store/__init__.py +47 -0
  30. soothe-0.1.0/soothe/backends/vector_store/in_memory.py +116 -0
  31. soothe-0.1.0/soothe/backends/vector_store/pgvector.py +246 -0
  32. soothe-0.1.0/soothe/backends/vector_store/weaviate.py +274 -0
  33. soothe-0.1.0/soothe/built_in_skills/__init__.py +69 -0
  34. soothe-0.1.0/soothe/built_in_skills/create-subagent/SKILL.md +342 -0
  35. soothe-0.1.0/soothe/cli/__init__.py +6 -0
  36. soothe-0.1.0/soothe/cli/commands.py +378 -0
  37. soothe-0.1.0/soothe/cli/daemon.py +504 -0
  38. soothe-0.1.0/soothe/cli/main.py +952 -0
  39. soothe-0.1.0/soothe/cli/progress_verbosity.py +65 -0
  40. soothe-0.1.0/soothe/cli/session.py +287 -0
  41. soothe-0.1.0/soothe/cli/tui_app.py +644 -0
  42. soothe-0.1.0/soothe/cli/tui_shared.py +439 -0
  43. soothe-0.1.0/soothe/config.py +566 -0
  44. soothe-0.1.0/soothe/core/__init__.py +6 -0
  45. soothe-0.1.0/soothe/core/agent.py +177 -0
  46. soothe-0.1.0/soothe/core/events.py +32 -0
  47. soothe-0.1.0/soothe/core/goal_engine.py +223 -0
  48. soothe-0.1.0/soothe/core/resolver.py +516 -0
  49. soothe-0.1.0/soothe/core/runner.py +1005 -0
  50. soothe-0.1.0/soothe/mcp/__init__.py +1 -0
  51. soothe-0.1.0/soothe/mcp/loader.py +123 -0
  52. soothe-0.1.0/soothe/middleware/__init__.py +6 -0
  53. soothe-0.1.0/soothe/middleware/policy.py +123 -0
  54. soothe-0.1.0/soothe/middleware/subagent_context.py +82 -0
  55. soothe-0.1.0/soothe/protocols/__init__.py +59 -0
  56. soothe-0.1.0/soothe/protocols/concurrency.py +23 -0
  57. soothe-0.1.0/soothe/protocols/context.py +113 -0
  58. soothe-0.1.0/soothe/protocols/durability.py +136 -0
  59. soothe-0.1.0/soothe/protocols/memory.py +99 -0
  60. soothe-0.1.0/soothe/protocols/planner.py +132 -0
  61. soothe-0.1.0/soothe/protocols/policy.py +189 -0
  62. soothe-0.1.0/soothe/protocols/remote.py +49 -0
  63. soothe-0.1.0/soothe/protocols/vector_store.py +140 -0
  64. soothe-0.1.0/soothe/subagents/__init__.py +19 -0
  65. soothe-0.1.0/soothe/subagents/browser.py +319 -0
  66. soothe-0.1.0/soothe/subagents/claude.py +207 -0
  67. soothe-0.1.0/soothe/subagents/planner.py +132 -0
  68. soothe-0.1.0/soothe/subagents/research.py +410 -0
  69. soothe-0.1.0/soothe/subagents/scout.py +122 -0
  70. soothe-0.1.0/soothe/subagents/skillify/__init__.py +257 -0
  71. soothe-0.1.0/soothe/subagents/skillify/indexer.py +349 -0
  72. soothe-0.1.0/soothe/subagents/skillify/models.py +58 -0
  73. soothe-0.1.0/soothe/subagents/skillify/retriever.py +235 -0
  74. soothe-0.1.0/soothe/subagents/skillify/warehouse.py +128 -0
  75. soothe-0.1.0/soothe/subagents/weaver/__init__.py +482 -0
  76. soothe-0.1.0/soothe/subagents/weaver/analyzer.py +81 -0
  77. soothe-0.1.0/soothe/subagents/weaver/composer.py +322 -0
  78. soothe-0.1.0/soothe/subagents/weaver/generator.py +175 -0
  79. soothe-0.1.0/soothe/subagents/weaver/models.py +136 -0
  80. soothe-0.1.0/soothe/subagents/weaver/registry.py +155 -0
  81. soothe-0.1.0/soothe/subagents/weaver/reuse.py +151 -0
  82. soothe-0.1.0/soothe/tools/__init__.py +1 -0
  83. soothe-0.1.0/soothe/tools/audio.py +201 -0
  84. soothe-0.1.0/soothe/tools/bash.py +228 -0
  85. soothe-0.1.0/soothe/tools/datetime.py +50 -0
  86. soothe-0.1.0/soothe/tools/document.py +368 -0
  87. soothe-0.1.0/soothe/tools/file_edit.py +569 -0
  88. soothe-0.1.0/soothe/tools/goals.py +111 -0
  89. soothe-0.1.0/soothe/tools/image.py +149 -0
  90. soothe-0.1.0/soothe/tools/jina.py +70 -0
  91. soothe-0.1.0/soothe/tools/python_executor.py +228 -0
  92. soothe-0.1.0/soothe/tools/serper.py +154 -0
  93. soothe-0.1.0/soothe/tools/tabular.py +173 -0
  94. soothe-0.1.0/soothe/tools/video.py +230 -0
  95. soothe-0.1.0/soothe/tools/wizsearch.py +232 -0
  96. soothe-0.1.0/soothe/utils/__init__.py +5 -0
  97. soothe-0.1.0/soothe/utils/progress.py +29 -0
  98. soothe-0.1.0/soothe/utils/runtime.py +90 -0
@@ -0,0 +1,211 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ uv.lock
102
+ .uv/
103
+
104
+ # poetry
105
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
106
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
107
+ # commonly ignored for libraries.
108
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
109
+ #poetry.lock
110
+ #poetry.toml
111
+
112
+ # pdm
113
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
114
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
115
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
116
+ #pdm.lock
117
+ #pdm.toml
118
+ .pdm-python
119
+ .pdm-build/
120
+
121
+ # pixi
122
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
123
+ #pixi.lock
124
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
125
+ # in the .venv directory. It is recommended not to include this directory in version control.
126
+ .pixi
127
+
128
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
129
+ __pypackages__/
130
+
131
+ # Celery stuff
132
+ celerybeat-schedule
133
+ celerybeat.pid
134
+
135
+ # SageMath parsed files
136
+ *.sage.py
137
+
138
+ # Environments
139
+ .env
140
+ .envrc
141
+ .venv
142
+ env/
143
+ venv/
144
+ ENV/
145
+ env.bak/
146
+ venv.bak/
147
+
148
+ # Spyder project settings
149
+ .spyderproject
150
+ .spyproject
151
+
152
+ # Rope project settings
153
+ .ropeproject
154
+
155
+ # mkdocs documentation
156
+ /site
157
+
158
+ # mypy
159
+ .mypy_cache/
160
+ .dmypy.json
161
+ dmypy.json
162
+
163
+ # Pyre type checker
164
+ .pyre/
165
+
166
+ # pytype static type analyzer
167
+ .pytype/
168
+
169
+ # Cython debug symbols
170
+ cython_debug/
171
+
172
+ # PyCharm
173
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
174
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
175
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
176
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
177
+ #.idea/
178
+
179
+ # Abstra
180
+ # Abstra is an AI-powered process automation framework.
181
+ # Ignore directories containing user credentials, local state, and settings.
182
+ # Learn more at https://abstra.io/docs
183
+ .abstra/
184
+
185
+ # Visual Studio Code
186
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
187
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
188
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
189
+ # you could uncomment the following to ignore the entire vscode folder
190
+ # .vscode/
191
+
192
+ # Ruff stuff:
193
+ .ruff_cache/
194
+
195
+ # PyPI configuration file
196
+ .pypirc
197
+
198
+ # Cursor
199
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
200
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
201
+ # refer to https://docs.cursor.com/context/ignore-files
202
+ .cursorignore
203
+ .cursorindexingignore
204
+
205
+ # Marimo
206
+ marimo/_static/
207
+ marimo/_lsp/
208
+ __marimo__/
209
+
210
+ .python-version
211
+ thirdparty/
soothe-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Xiaming Chen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
soothe-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,304 @@
1
+ Metadata-Version: 2.4
2
+ Name: soothe
3
+ Version: 0.1.0
4
+ Summary: Multi-agent harness built on deepagents and langchain/langgraph.
5
+ License: MIT
6
+ License-File: LICENSE
7
+ Keywords: agents,ai,langchain,langgraph,llm,multi-agent,subagents
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Programming Language :: Python :: 3.13
15
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
16
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
+ Requires-Python: <4.0,>=3.11
18
+ Requires-Dist: anyio>=3.0.0
19
+ Requires-Dist: deepagents<1.0.0,>=0.4.10
20
+ Requires-Dist: langchain-community<1.0.0,>=0.3.0
21
+ Requires-Dist: langchain-core<2.0.0,>=1.2.18
22
+ Requires-Dist: langchain-mcp-adapters<1.0.0,>=0.2.0
23
+ Requires-Dist: langchain-openai<1.0.0,>=0.3.0
24
+ Requires-Dist: langchain<2.0.0,>=1.2.11
25
+ Requires-Dist: langgraph<2.0.0,>=1.1.1
26
+ Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
27
+ Requires-Dist: pydantic<3.0.0,>=2.0.0
28
+ Requires-Dist: python-dotenv<2.0.0,>=1.0.0
29
+ Requires-Dist: pyyaml<7.0.0,>=6.0.0
30
+ Requires-Dist: textual>=0.40.0
31
+ Requires-Dist: typer[all]<1.0.0,>=0.9.0
32
+ Provides-Extra: all
33
+ Requires-Dist: aiohttp>=3.9.0; extra == 'all'
34
+ Requires-Dist: browser-use<=0.12.0; extra == 'all'
35
+ Requires-Dist: claude-agent-sdk>=0.1.40; extra == 'all'
36
+ Requires-Dist: google-genai>=0.3.0; extra == 'all'
37
+ Requires-Dist: ipython>=8.0.0; extra == 'all'
38
+ Requires-Dist: langchain-ollama>=0.3.0; extra == 'all'
39
+ Requires-Dist: langchain-tavily>=0.2.17; extra == 'all'
40
+ Requires-Dist: matplotlib>=3.8.0; extra == 'all'
41
+ Requires-Dist: openai>=1.0.0; extra == 'all'
42
+ Requires-Dist: pexpect>=4.9.0; extra == 'all'
43
+ Requires-Dist: pgvector>=0.3; extra == 'all'
44
+ Requires-Dist: pillow>=10.0.0; extra == 'all'
45
+ Requires-Dist: psycopg[pool]>=3.1; extra == 'all'
46
+ Requires-Dist: pymupdf>=1.24.0; extra == 'all'
47
+ Requires-Dist: requests>=2.31.0; extra == 'all'
48
+ Requires-Dist: rocksdict>=0.3; extra == 'all'
49
+ Requires-Dist: tavily-python>=0.5.0; extra == 'all'
50
+ Requires-Dist: weaviate-client>=4.0; extra == 'all'
51
+ Requires-Dist: wizsearch<2.0.0,>=1.1.2; extra == 'all'
52
+ Provides-Extra: audio-full
53
+ Requires-Dist: aiohttp>=3.9.0; extra == 'audio-full'
54
+ Provides-Extra: bash
55
+ Requires-Dist: pexpect>=4.9.0; extra == 'bash'
56
+ Provides-Extra: browser
57
+ Requires-Dist: browser-use<=0.12.0; extra == 'browser'
58
+ Provides-Extra: claude
59
+ Requires-Dist: claude-agent-sdk>=0.1.40; extra == 'claude'
60
+ Provides-Extra: document
61
+ Requires-Dist: pymupdf>=1.24.0; extra == 'document'
62
+ Provides-Extra: jina
63
+ Requires-Dist: aiohttp>=3.9.0; extra == 'jina'
64
+ Provides-Extra: media
65
+ Requires-Dist: openai>=1.0.0; extra == 'media'
66
+ Requires-Dist: pillow>=10.0.0; extra == 'media'
67
+ Provides-Extra: ollama
68
+ Requires-Dist: langchain-ollama>=0.3.0; extra == 'ollama'
69
+ Provides-Extra: pgvector
70
+ Requires-Dist: pgvector>=0.3; extra == 'pgvector'
71
+ Requires-Dist: psycopg[pool]>=3.1; extra == 'pgvector'
72
+ Provides-Extra: python-executor
73
+ Requires-Dist: ipython>=8.0.0; extra == 'python-executor'
74
+ Requires-Dist: matplotlib>=3.8.0; extra == 'python-executor'
75
+ Provides-Extra: research
76
+ Requires-Dist: langchain-tavily>=0.2.17; extra == 'research'
77
+ Requires-Dist: tavily-python>=0.5.0; extra == 'research'
78
+ Requires-Dist: wizsearch<2.0.0,>=1.1.2; extra == 'research'
79
+ Provides-Extra: rocksdb
80
+ Requires-Dist: rocksdict>=0.3; extra == 'rocksdb'
81
+ Provides-Extra: serper
82
+ Requires-Dist: requests>=2.31.0; extra == 'serper'
83
+ Provides-Extra: video
84
+ Requires-Dist: google-genai>=0.3.0; extra == 'video'
85
+ Provides-Extra: weaviate
86
+ Requires-Dist: weaviate-client>=4.0; extra == 'weaviate'
87
+ Provides-Extra: wizsearch
88
+ Requires-Dist: langchain-tavily>=0.2.17; extra == 'wizsearch'
89
+ Requires-Dist: wizsearch<2.0.0,>=1.1.2; extra == 'wizsearch'
90
+ Description-Content-Type: text/markdown
91
+
92
+ # Soothe
93
+
94
+ A protocol-driven orchestration framework for building 24/7 long-running autonomous agents.
95
+ Built on [deepagents](https://github.com/deepagents-ai/deepagents) and the langchain/langgraph ecosystem.
96
+
97
+ ## Architecture
98
+
99
+ ```
100
+ +--------------------------------------------------------------+
101
+ | Soothe (orchestration framework) |
102
+ | Protocols: Context, Memory, Planner, Policy, Durability, |
103
+ | RemoteAgent, Concurrency, VectorStore |
104
+ | CLI TUI: SootheRunner, Rich Live display, slash commands |
105
+ | create_soothe_agent() wires everything together |
106
+ +--------------------------------------------------------------+
107
+ | deepagents (agent framework) |
108
+ | BackendProtocol, AgentMiddleware, SubAgent, Summarization |
109
+ | create_deep_agent() |
110
+ +--------------------------------------------------------------+
111
+ | langchain / langgraph (runtime layer) |
112
+ | BaseChatModel, BaseTool, StateGraph, Checkpointer |
113
+ +--------------------------------------------------------------+
114
+ ```
115
+
116
+ Soothe extends deepagents with seven core protocols that the ecosystem does not provide:
117
+ cognitive context engineering, cross-thread memory, plan-driven execution, least-privilege
118
+ policy, durable thread lifecycle, remote agent interop, and controlled concurrency.
119
+ It does not implement domain logic -- it composes capabilities provided by langchain tools,
120
+ MCP servers, deepagents subagents, and remote agents via ACP/A2A.
121
+
122
+ ## Quick Start
123
+
124
+ ### Prerequisites
125
+
126
+ - Python 3.11+
127
+ - [uv](https://docs.astral.sh/uv/) (recommended) or pip
128
+
129
+ ### Install
130
+
131
+ ```bash
132
+ git clone <repository-url>
133
+ cd soothe
134
+ make sync # or: uv sync --all-extras
135
+ ```
136
+
137
+ ### Configure
138
+
139
+ ```bash
140
+ cp config/env.example .env # set your API keys
141
+ cp config/config.yml my-config.yml # customize as needed
142
+ ```
143
+
144
+ At minimum, set `OPENAI_API_KEY` in `.env` (or export it in your shell).
145
+
146
+ ### Run
147
+
148
+ ```bash
149
+ # Interactive TUI mode
150
+ soothe run
151
+
152
+ # Single prompt (headless)
153
+ soothe run "Summarize the latest AI research papers"
154
+
155
+ # With config file and thread resume
156
+ soothe run --config my-config.yml --thread abc123
157
+ ```
158
+
159
+ ## Configuration
160
+
161
+ Soothe is configured through two mechanisms:
162
+
163
+ - **Environment variables** -- See [`config/env.example`](config/env.example) for the full list.
164
+ `SOOTHE_*` vars map directly to `SootheConfig` fields via pydantic-settings.
165
+ Provider and tool keys (`OPENAI_API_KEY`, `SERPER_API_KEY`, etc.) are standard env vars.
166
+
167
+ - **YAML config file** -- See [`config/config.yml`](config/config.yml) for a fully-commented
168
+ example. Pass via `soothe run --config path/to/config.yml`. Supports `${ENV_VAR}` syntax
169
+ in `providers[].api_key` for secret injection.
170
+
171
+ ## CLI
172
+
173
+ | Command | Description |
174
+ |---------|-------------|
175
+ | `soothe run` | Interactive TUI with Rich Live display |
176
+ | `soothe run "prompt"` | Headless single-prompt mode |
177
+ | `soothe run --no-tui` | Headless interactive mode (no Rich) |
178
+ | `soothe thread list` | List all threads |
179
+ | `soothe thread archive <id>` | Archive a thread |
180
+ | `soothe list-subagents` | Show available subagents |
181
+ | `soothe config` | Display current configuration |
182
+
183
+ ### TUI Slash Commands
184
+
185
+ | Command | Description |
186
+ |---------|-------------|
187
+ | `/help` | Commands and subagent selector |
188
+ | `/plan` | Show current task plan |
189
+ | `/memory` | Memory statistics |
190
+ | `/context` | Context statistics |
191
+ | `/policy` | Active policy profile |
192
+ | `/thread list` | List threads |
193
+ | `/thread resume <id>` | Resume a thread |
194
+ | `/config` | Active configuration |
195
+ | `/exit` | Exit |
196
+
197
+ Numeric prefix routes to subagents: `1`=Main, `2`=Planner, `3`=Scout, `4`=Research, `5`=Browser, `6`=Claude, `7`=Skillify, `8`=Weaver.
198
+
199
+ ## Project Structure
200
+
201
+ ```
202
+ src/soothe/
203
+ ├── __init__.py # Public API exports
204
+ ├── config.py # SootheConfig (pydantic-settings)
205
+ ├── protocols/ # Runtime-agnostic protocol definitions
206
+ ├── backends/ # Protocol implementations
207
+ │ ├── context/ # KeywordContext, VectorContext
208
+ │ ├── memory/ # StoreBackedMemory, VectorMemory
209
+ │ ├── planning/ # DirectPlanner
210
+ │ ├── policy/ # ConfigDrivenPolicy
211
+ │ ├── durability/ # InMemoryDurability
212
+ │ ├── remote/ # LangGraphRemoteAgent
213
+ │ ├── persistence/ # JSON, RocksDB stores
214
+ │ └── vector_store/ # PGVector, Weaviate
215
+ ├── middleware/ # ContextMiddleware, PolicyMiddleware
216
+ ├── core/ # agent, runner, resolver, goal_engine (autonomous iteration)
217
+ ├── subagents/ # planner, scout, research, browser, claude, skillify, weaver
218
+ ├── tools/ # jina, serper, image, audio, video, tabular, bash, file_edit, document, python_executor, goals, wizsearch
219
+ ├── mcp/ # MCP server loading
220
+ ├── cli/ # Typer CLI, SootheRunner, Rich TUI
221
+ ├── built_in_skills/ # Built-in skill implementations
222
+ └── utils/ # Streaming helpers
223
+ ```
224
+
225
+ ## Documentation
226
+
227
+ ### Design Specifications
228
+
229
+ | RFC | Title |
230
+ |-----|-------|
231
+ | [RFC-0001](docs/specs/RFC-0001.md) | System Conceptual Design |
232
+ | [RFC-0002](docs/specs/RFC-0002.md) | Core Modules Architecture Design |
233
+ | [RFC-0003](docs/specs/RFC-0003.md) | CLI TUI Architecture Design |
234
+ | [RFC-0004](docs/specs/RFC-0004.md) | Skillify Agent Architecture Design |
235
+ | [RFC-0005](docs/specs/RFC-0005.md) | Weaver Agent Architecture Design |
236
+ | [RFC-0006](docs/specs/RFC-0006.md) | Context and Memory Architecture Design |
237
+ | [RFC-0007](docs/specs/RFC-0007.md) | Autonomous Iteration Loop |
238
+
239
+ ### Implementation Guides
240
+
241
+ | Guide | Title |
242
+ |-------|-------|
243
+ | [IG-001](docs/impl/001-soothe-setup-migration.md) | Soothe Setup and Migration |
244
+ | [IG-002](docs/impl/002-soothe-polish.md) | Soothe Polish |
245
+ | [IG-003](docs/impl/003-streaming-examples.md) | Streaming Examples |
246
+ | [IG-004](docs/impl/004-ecosystem-capability-analysis.md) | Ecosystem Capability Analysis |
247
+ | [IG-005](docs/impl/005-core-protocols-implementation.md) | Core Protocols Implementation |
248
+ | [IG-006](docs/impl/006-vectorstore-router-persistence.md) | VectorStore, Router, Persistence |
249
+ | [IG-007](docs/impl/007-cli-tui-implementation.md) | CLI TUI Implementation |
250
+ | [IG-008](docs/impl/008-config-docs-revision.md) | Config and Docs Revision |
251
+ | [IG-009](docs/impl/009-ollama-provider.md) | Ollama Provider |
252
+ | [IG-010](docs/impl/010-tui-layout-history-refresh.md) | TUI Layout, History, and Refresh |
253
+ | [IG-011](docs/impl/011-skillify-agent-implementation.md) | Skillify Agent Implementation |
254
+ | [IG-012](docs/impl/012-weaver-agent-implementation.md) | Weaver Agent Implementation |
255
+ | [IG-013](docs/impl/013-soothe-polish-pass.md) | Soothe Polish Pass |
256
+ | [IG-014](docs/impl/014-code-structure-revision.md) | Code Structure Revision |
257
+ | [IG-015](docs/impl/015-rfc-gap-closure-and-compat-hard-cut.md) | RFC Gap Closure and Compatibility Hard-Cut |
258
+ | [IG-016](docs/impl/016-agent-optimization-pass.md) | Agent Optimization Pass |
259
+ | [IG-017](docs/impl/017-progress-events-tools-polish.md) | Progress Events and Tools Polish |
260
+ | [IG-018](docs/impl/018-autonomous-iteration-loop.md) | Autonomous Iteration Loop |
261
+ | [IG-019](docs/impl/019-soothe-tools-enhancement.md) | Soothe Tools Enhancement |
262
+
263
+ ### User Guide
264
+
265
+ See [docs/user_guide.md](docs/user_guide.md) for the comprehensive end-user guide.
266
+
267
+ ## Privacy
268
+
269
+ The Browser subagent uses [browser-use](https://github.com/browser-use/browser-use)
270
+ with **privacy-first defaults**: browser extensions, cloud services, and anonymous
271
+ telemetry are disabled by default. Re-enable them in the subagent config if needed:
272
+
273
+ ```yaml
274
+ subagents:
275
+ browser:
276
+ enabled: true
277
+ config:
278
+ disable_extensions: false
279
+ disable_cloud: false
280
+ disable_telemetry: false
281
+ ```
282
+
283
+ ## Development
284
+
285
+ ```bash
286
+ make help # show all commands
287
+ make sync-dev # sync dev dependencies
288
+ make format # format code with ruff
289
+ make lint # lint code with ruff
290
+ make test # run all tests
291
+ make test-unit # run unit tests only
292
+ make build # build the package
293
+ ```
294
+
295
+ ### Infrastructure (for integration tests)
296
+
297
+ ```bash
298
+ docker compose up -d # starts PGVector + Weaviate
299
+ make test-integration # requires --run-integration
300
+ ```
301
+
302
+ ## License
303
+
304
+ MIT