ai-boss 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 (38) hide show
  1. ai_boss-0.1.0/CHANGELOG.md +53 -0
  2. ai_boss-0.1.0/LICENSE +201 -0
  3. ai_boss-0.1.0/MANIFEST.in +5 -0
  4. ai_boss-0.1.0/PKG-INFO +170 -0
  5. ai_boss-0.1.0/README.md +130 -0
  6. ai_boss-0.1.0/ai_boss/__init__.py +2 -0
  7. ai_boss-0.1.0/ai_boss/__main__.py +3 -0
  8. ai_boss-0.1.0/ai_boss/commands.py +562 -0
  9. ai_boss-0.1.0/ai_boss/config.py +173 -0
  10. ai_boss-0.1.0/ai_boss/context.py +258 -0
  11. ai_boss-0.1.0/ai_boss/file_ops.py +111 -0
  12. ai_boss-0.1.0/ai_boss/i18n.py +46 -0
  13. ai_boss-0.1.0/ai_boss/llm_client.py +583 -0
  14. ai_boss-0.1.0/ai_boss/locales/en.json +209 -0
  15. ai_boss-0.1.0/ai_boss/locales/ru.json +1 -0
  16. ai_boss-0.1.0/ai_boss/logger.py +349 -0
  17. ai_boss-0.1.0/ai_boss/main.py +313 -0
  18. ai_boss-0.1.0/ai_boss/notifications.py +15 -0
  19. ai_boss-0.1.0/ai_boss/onboarding.py +275 -0
  20. ai_boss-0.1.0/ai_boss/postprocessor.py +278 -0
  21. ai_boss-0.1.0/ai_boss/preprocessor.py +163 -0
  22. ai_boss-0.1.0/ai_boss/suppress_output.py +22 -0
  23. ai_boss-0.1.0/ai_boss/timer_manager.py +75 -0
  24. ai_boss-0.1.0/ai_boss/tools.py +450 -0
  25. ai_boss-0.1.0/ai_boss/ui.py +190 -0
  26. ai_boss-0.1.0/ai_boss/workspace_templates/morning_check.txt +36 -0
  27. ai_boss-0.1.0/ai_boss/workspace_templates/planner_prompt.txt +47 -0
  28. ai_boss-0.1.0/ai_boss/workspace_templates/postprocessor_prompt.txt +95 -0
  29. ai_boss-0.1.0/ai_boss/workspace_templates/system_prompt.txt +39 -0
  30. ai_boss-0.1.0/ai_boss/workspace_templates/user_profile.txt +39 -0
  31. ai_boss-0.1.0/ai_boss.egg-info/PKG-INFO +170 -0
  32. ai_boss-0.1.0/ai_boss.egg-info/SOURCES.txt +36 -0
  33. ai_boss-0.1.0/ai_boss.egg-info/dependency_links.txt +1 -0
  34. ai_boss-0.1.0/ai_boss.egg-info/entry_points.txt +2 -0
  35. ai_boss-0.1.0/ai_boss.egg-info/requires.txt +8 -0
  36. ai_boss-0.1.0/ai_boss.egg-info/top_level.txt +1 -0
  37. ai_boss-0.1.0/pyproject.toml +101 -0
  38. ai_boss-0.1.0/setup.cfg +4 -0
@@ -0,0 +1,53 @@
1
+ # Changelog
2
+
3
+ [English](CHANGELOG.md) | [Русский](CHANGELOG.ru.md)
4
+
5
+ All notable changes to this project will be documented in this file.
6
+
7
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
8
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9
+
10
+ ## [Unreleased]
11
+
12
+ ### Added
13
+ - Planned features for future releases.
14
+
15
+ ## [0.1.0] - 2026-10-06
16
+
17
+ First public alpha release.
18
+
19
+ ### Added
20
+ - Local AI mentor BOSS (Brain-Operating Support System) for the terminal.
21
+ - Support for any OpenAI-compatible LLM (Ollama, LM Studio, vLLM, llama.cpp, OpenRouter, etc.).
22
+ - First-run onboarding: language selection, workspace directory, and LLM connection settings.
23
+ - Workspace (`workspace/`) with state files:
24
+ - `system_prompt.txt` — system prompt;
25
+ - `user_profile.txt` — user profile;
26
+ - `chat_history.json` — conversation history;
27
+ - `plan_today.txt` / `plan_tomorrow.txt` — daily and next-day plans;
28
+ - `diary.txt` — success diary;
29
+ - `timers.json` — active reminders;
30
+ - `files/` — custom files created by the AI.
31
+ - Tool calling for the LLM:
32
+ - create, update, rename, and delete files;
33
+ - update user profile;
34
+ - set and remove timers;
35
+ - send system notifications;
36
+ - append to diary;
37
+ - update tomorrow's plan.
38
+ - Preprocessors and postprocessors — background tasks executed before and after the main dialogue.
39
+ - Morning actualization (`morning_check`) with automatic plan rollover and history cleanup.
40
+ - Timer manager with automatic AI wake-up.
41
+ - Interactive commands with `!` prefix (`!help`, `!status`, `!reset`, `!model`, `!language`, etc.).
42
+ - In-terminal file viewer for the `files/` folder via `/files/path/to/file`.
43
+ - Rich terminal UI: markdown rendering, syntax highlighting, reasoning display, usage and timings.
44
+ - Russian and English interface languages (i18n).
45
+ - Optional detailed logging of LLM traffic, tool calls, and pre-/postprocessor snapshots.
46
+ - Atomic file operations for crash resilience.
47
+ - Cross-platform notifications and attention hooks (Windows, Linux, macOS).
48
+
49
+ ### Security
50
+ - Masking of API keys and sensitive data in logs.
51
+
52
+ [Unreleased]: https://github.com/backup64back-afk/Ai-Boss/compare/v0.1.0...HEAD
53
+ [0.1.0]: https://github.com/backup64back-afk/Ai-Boss/releases/tag/v0.1.0
ai_boss-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+  Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 backup64
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ include README.md
2
+ include LICENSE
3
+ include CHANGELOG.md
4
+ recursive-include ai_boss/locales *.json
5
+ recursive-include ai_boss/workspace_templates *
ai_boss-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,170 @@
1
+ Metadata-Version: 2.4
2
+ Name: ai-boss
3
+ Version: 0.1.0
4
+ Summary: AI BOSS (Brain-Operating Support System) — a local AI mentor and life-assistant powered by any OpenAI-compatible LLM.
5
+ Author-email: backup64 <backup.64.back@gmail.com>
6
+ Maintainer-email: backup64 <backup.64.back@gmail.com>
7
+ License-Expression: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/backup64back-afk/Ai-Boss
9
+ Project-URL: Repository, https://github.com/backup64back-afk/Ai-Boss
10
+ Project-URL: Issues, https://github.com/backup64back-afk/Ai-Boss/issues
11
+ Project-URL: Changelog, https://github.com/backup64back-afk/Ai-Boss/blob/main/CHANGELOG.md
12
+ Keywords: ai,assistant,llm,mentor,coach,productivity,boss,brain-operating-support-system,openai,chatgpt,local-llm,ollama,lm-studio
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Environment :: Console
15
+ Classifier: Intended Audience :: End Users/Desktop
16
+ Classifier: Natural Language :: English
17
+ Classifier: Natural Language :: Russian
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
24
+ Classifier: Topic :: Office/Business :: Scheduling
25
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
26
+ Classifier: Topic :: Terminals
27
+ Classifier: Topic :: Utilities
28
+ Classifier: Typing :: Typed
29
+ Requires-Python: >=3.10
30
+ Description-Content-Type: text/markdown
31
+ License-File: LICENSE
32
+ Requires-Dist: openai>=1.30.0
33
+ Requires-Dist: httpx<1.0.0,>=0.24.0
34
+ Requires-Dist: rich>=13.7.0
35
+ Requires-Dist: plyer>=2.1.0
36
+ Provides-Extra: dev
37
+ Requires-Dist: build>=1.2; extra == "dev"
38
+ Requires-Dist: twine>=5.0; extra == "dev"
39
+ Dynamic: license-file
40
+
41
+ # AI BOSS (Brain-Operating Support System)
42
+
43
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
44
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
45
+ [![Status: Alpha](https://img.shields.io/badge/status-alpha-orange.svg)](#)
46
+
47
+ [English](README.md) | [Русский](https://github.com/backup64back-afk/Ai-Boss/blob/master/README.ru.md)
48
+
49
+ **AI BOSS** is a local AI mentor and life-assistant that runs entirely in your terminal.
50
+ It connects to any OpenAI-compatible LLM (local or remote) and helps you manage tasks, plans, diary, reminders, and personal growth through a structured workspace.
51
+
52
+ > **Note:** This project is in active alpha development. APIs and file formats may change.
53
+
54
+ ## Features
55
+
56
+ - **Local & Private** – Works with local LLMs (Ollama, LM Studio, vLLM, llama.cpp) or any OpenAI-compatible API.
57
+ - **Persistent Workspace** – Keeps your profile, plans (today/tomorrow), diary, and custom files in a dedicated folder.
58
+ - **AI Tools** – The assistant can create/update/delete files, set timers, send system notifications, update your profile, and more.
59
+ - **Preprocessors & Postprocessors** – Background tasks that run before/after the main conversation (e.g., morning routine, evening reflection).
60
+ - **Timer Manager** – Set reminders; the AI wakes up automatically and notifies you.
61
+ - **Rich Terminal UI** – Beautiful markdown rendering, syntax highlighting, reasoning display, and usage/timings.
62
+ - **Multilingual** – Russian and English interfaces (more can be added via locale files).
63
+ - **Debugging & Transparency** – Optional logging of all LLM traffic, tool calls, and pre/postprocessor snapshots.
64
+
65
+ ## Installation
66
+
67
+ ```bash
68
+ pip install ai-boss
69
+ ```
70
+
71
+ Requires **Python 3.10** or newer.
72
+
73
+ ## Quick Start
74
+
75
+ After installation, simply run:
76
+
77
+ ```bash
78
+ ai-boss
79
+ ```
80
+
81
+ On first launch, an onboarding wizard will guide you through:
82
+
83
+ 1. Choosing the interface language.
84
+ 2. Selecting a workspace directory (where state files are stored).
85
+ 3. Configuring the LLM connection (API base URL, API key, model name).
86
+ 4. Advanced options (logging, reasoning effort, postprocessor quiet mode, etc.).
87
+
88
+ The wizard creates `config.json` and a `workspace/` folder with template files.
89
+
90
+ ## Usage
91
+
92
+ Once running, you can chat with the AI naturally. Commands start with `!` (e.g., `!help`).
93
+ The AI can also use tools autonomously to manage your workspace.
94
+
95
+ ### Common Commands
96
+
97
+ | Command | Description |
98
+ |---------|-------------|
99
+ | `!help` | Show all available commands |
100
+ | `!status` | List files managed by the AI |
101
+ | `!profile` | View or edit your user profile |
102
+ | `!system_prompt` | View or edit the system prompt |
103
+ | `!model` | Change the LLM model |
104
+ | `!language` | Switch interface language (ru/en) |
105
+ | `!reset` | Clear conversation history |
106
+ | `!redo` | Regenerate the last assistant response |
107
+ | `!exit` | Quit the application |
108
+
109
+ To view a file from the `files/` folder directly in the terminal, type:
110
+
111
+ ```
112
+ /files/path/to/file.md
113
+ ```
114
+
115
+ Without a path, it lists all files.
116
+
117
+ ## How It Works
118
+
119
+ AI BOSS maintains a workspace with the following structure:
120
+
121
+ ```
122
+ workspace/
123
+ ├── system_prompt.txt # Core instructions for the AI
124
+ ├── user_profile.txt # Information about you
125
+ ├── chat_history.json # Conversation history
126
+ ├── plan_today.txt # Today's plan (read-only after morning reset)
127
+ ├── plan_tomorrow.txt # Tomorrow's plan (editable)
128
+ ├── diary.txt # Success diary
129
+ ├── timers.json # Active reminders
130
+ └── files/ # Custom files created by the AI
131
+ ```
132
+
133
+ Before each LLM call, the system assembles context from these files and injects it as tool results.
134
+ The AI can call tools to modify the workspace.
135
+ After the main response, **postprocessors** run in background threads to perform tasks like updating plans or reflecting on the conversation.
136
+ **Preprocessors** run before the main call (e.g., morning actualization).
137
+
138
+ ## Configuration
139
+
140
+ Configuration is stored in `config.json` in the current working directory.
141
+ You can edit it manually or use interactive commands.
142
+
143
+ Key settings include:
144
+
145
+ - `llm`: API base, key, model, context window, max tokens, reasoning effort.
146
+ - `workspace_dir`: Where state files are stored.
147
+ - `preprocessors` / `postprocessors`: Background task definitions.
148
+ - `language`: Interface language (`ru` or `en`).
149
+ - `debug_traffic`: Enable detailed logging to `logs/`.
150
+
151
+ ## Contributing
152
+
153
+ Contributions are welcome!
154
+ Please open an issue or pull request on [GitHub](https://github.com/backup64back-afk/Ai-Boss).
155
+
156
+ ## License
157
+
158
+ This project is licensed under the **Apache License 2.0** – see the [LICENSE](LICENSE) file for details.
159
+
160
+ ## Links
161
+
162
+ - **GitHub:** https://github.com/backup64back-afk/Ai-Boss
163
+ - **Issues:** https://github.com/backup64back-afk/Ai-Boss/issues
164
+ - **Changelog:** https://github.com/backup64back-afk/Ai-Boss/blob/main/CHANGELOG.md
165
+
166
+ ---
167
+
168
+ *Made with ❤️ for personal growth and productivity.*
169
+
170
+ 🇷🇺 [Русская версия](https://github.com/backup64back-afk/Ai-Boss/blob/main/README.ru.md)
@@ -0,0 +1,130 @@
1
+ # AI BOSS (Brain-Operating Support System)
2
+
3
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
5
+ [![Status: Alpha](https://img.shields.io/badge/status-alpha-orange.svg)](#)
6
+
7
+ [English](README.md) | [Русский](https://github.com/backup64back-afk/Ai-Boss/blob/master/README.ru.md)
8
+
9
+ **AI BOSS** is a local AI mentor and life-assistant that runs entirely in your terminal.
10
+ It connects to any OpenAI-compatible LLM (local or remote) and helps you manage tasks, plans, diary, reminders, and personal growth through a structured workspace.
11
+
12
+ > **Note:** This project is in active alpha development. APIs and file formats may change.
13
+
14
+ ## Features
15
+
16
+ - **Local & Private** – Works with local LLMs (Ollama, LM Studio, vLLM, llama.cpp) or any OpenAI-compatible API.
17
+ - **Persistent Workspace** – Keeps your profile, plans (today/tomorrow), diary, and custom files in a dedicated folder.
18
+ - **AI Tools** – The assistant can create/update/delete files, set timers, send system notifications, update your profile, and more.
19
+ - **Preprocessors & Postprocessors** – Background tasks that run before/after the main conversation (e.g., morning routine, evening reflection).
20
+ - **Timer Manager** – Set reminders; the AI wakes up automatically and notifies you.
21
+ - **Rich Terminal UI** – Beautiful markdown rendering, syntax highlighting, reasoning display, and usage/timings.
22
+ - **Multilingual** – Russian and English interfaces (more can be added via locale files).
23
+ - **Debugging & Transparency** – Optional logging of all LLM traffic, tool calls, and pre/postprocessor snapshots.
24
+
25
+ ## Installation
26
+
27
+ ```bash
28
+ pip install ai-boss
29
+ ```
30
+
31
+ Requires **Python 3.10** or newer.
32
+
33
+ ## Quick Start
34
+
35
+ After installation, simply run:
36
+
37
+ ```bash
38
+ ai-boss
39
+ ```
40
+
41
+ On first launch, an onboarding wizard will guide you through:
42
+
43
+ 1. Choosing the interface language.
44
+ 2. Selecting a workspace directory (where state files are stored).
45
+ 3. Configuring the LLM connection (API base URL, API key, model name).
46
+ 4. Advanced options (logging, reasoning effort, postprocessor quiet mode, etc.).
47
+
48
+ The wizard creates `config.json` and a `workspace/` folder with template files.
49
+
50
+ ## Usage
51
+
52
+ Once running, you can chat with the AI naturally. Commands start with `!` (e.g., `!help`).
53
+ The AI can also use tools autonomously to manage your workspace.
54
+
55
+ ### Common Commands
56
+
57
+ | Command | Description |
58
+ |---------|-------------|
59
+ | `!help` | Show all available commands |
60
+ | `!status` | List files managed by the AI |
61
+ | `!profile` | View or edit your user profile |
62
+ | `!system_prompt` | View or edit the system prompt |
63
+ | `!model` | Change the LLM model |
64
+ | `!language` | Switch interface language (ru/en) |
65
+ | `!reset` | Clear conversation history |
66
+ | `!redo` | Regenerate the last assistant response |
67
+ | `!exit` | Quit the application |
68
+
69
+ To view a file from the `files/` folder directly in the terminal, type:
70
+
71
+ ```
72
+ /files/path/to/file.md
73
+ ```
74
+
75
+ Without a path, it lists all files.
76
+
77
+ ## How It Works
78
+
79
+ AI BOSS maintains a workspace with the following structure:
80
+
81
+ ```
82
+ workspace/
83
+ ├── system_prompt.txt # Core instructions for the AI
84
+ ├── user_profile.txt # Information about you
85
+ ├── chat_history.json # Conversation history
86
+ ├── plan_today.txt # Today's plan (read-only after morning reset)
87
+ ├── plan_tomorrow.txt # Tomorrow's plan (editable)
88
+ ├── diary.txt # Success diary
89
+ ├── timers.json # Active reminders
90
+ └── files/ # Custom files created by the AI
91
+ ```
92
+
93
+ Before each LLM call, the system assembles context from these files and injects it as tool results.
94
+ The AI can call tools to modify the workspace.
95
+ After the main response, **postprocessors** run in background threads to perform tasks like updating plans or reflecting on the conversation.
96
+ **Preprocessors** run before the main call (e.g., morning actualization).
97
+
98
+ ## Configuration
99
+
100
+ Configuration is stored in `config.json` in the current working directory.
101
+ You can edit it manually or use interactive commands.
102
+
103
+ Key settings include:
104
+
105
+ - `llm`: API base, key, model, context window, max tokens, reasoning effort.
106
+ - `workspace_dir`: Where state files are stored.
107
+ - `preprocessors` / `postprocessors`: Background task definitions.
108
+ - `language`: Interface language (`ru` or `en`).
109
+ - `debug_traffic`: Enable detailed logging to `logs/`.
110
+
111
+ ## Contributing
112
+
113
+ Contributions are welcome!
114
+ Please open an issue or pull request on [GitHub](https://github.com/backup64back-afk/Ai-Boss).
115
+
116
+ ## License
117
+
118
+ This project is licensed under the **Apache License 2.0** – see the [LICENSE](LICENSE) file for details.
119
+
120
+ ## Links
121
+
122
+ - **GitHub:** https://github.com/backup64back-afk/Ai-Boss
123
+ - **Issues:** https://github.com/backup64back-afk/Ai-Boss/issues
124
+ - **Changelog:** https://github.com/backup64back-afk/Ai-Boss/blob/main/CHANGELOG.md
125
+
126
+ ---
127
+
128
+ *Made with ❤️ for personal growth and productivity.*
129
+
130
+ 🇷🇺 [Русская версия](https://github.com/backup64back-afk/Ai-Boss/blob/main/README.ru.md)
@@ -0,0 +1,2 @@
1
+ """БОСС — локальный ИИ-наставник."""
2
+ __version__ = "0.1.0"
@@ -0,0 +1,3 @@
1
+ from .main import main
2
+ if __name__ == "__main__":
3
+ main()