federate 0.9.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 (33) hide show
  1. federate-0.9.0/LICENSE +201 -0
  2. federate-0.9.0/MANIFEST.in +15 -0
  3. federate-0.9.0/PKG-INFO +143 -0
  4. federate-0.9.0/README.md +92 -0
  5. federate-0.9.0/go/cmd/bridge/main.go +425 -0
  6. federate-0.9.0/go/cmd/embed/main.go +72 -0
  7. federate-0.9.0/go/cmd/search/main.go +82 -0
  8. federate-0.9.0/go/go.mod +31 -0
  9. federate-0.9.0/go/go.sum +75 -0
  10. federate-0.9.0/pyproject.toml +80 -0
  11. federate-0.9.0/scripts/build_go.sh +41 -0
  12. federate-0.9.0/setup.cfg +4 -0
  13. federate-0.9.0/setup.py +25 -0
  14. federate-0.9.0/src/federate.egg-info/PKG-INFO +143 -0
  15. federate-0.9.0/src/federate.egg-info/SOURCES.txt +31 -0
  16. federate-0.9.0/src/federate.egg-info/dependency_links.txt +1 -0
  17. federate-0.9.0/src/federate.egg-info/entry_points.txt +2 -0
  18. federate-0.9.0/src/federate.egg-info/requires.txt +32 -0
  19. federate-0.9.0/src/federate.egg-info/top_level.txt +1 -0
  20. federate-0.9.0/src/meerkat/__init__.py +4 -0
  21. federate-0.9.0/src/meerkat/__main__.py +6 -0
  22. federate-0.9.0/src/meerkat/agent.py +2333 -0
  23. federate-0.9.0/src/meerkat/app.py +263 -0
  24. federate-0.9.0/src/meerkat/audio_handler.py +529 -0
  25. federate-0.9.0/src/meerkat/commands.py +579 -0
  26. federate-0.9.0/src/meerkat/execution.py +330 -0
  27. federate-0.9.0/src/meerkat/meerkat.py +263 -0
  28. federate-0.9.0/src/meerkat/orchestration.py +450 -0
  29. federate-0.9.0/src/meerkat/semantic_search.py +138 -0
  30. federate-0.9.0/src/meerkat/subagents.py +199 -0
  31. federate-0.9.0/src/meerkat/telegram_handler.py +301 -0
  32. federate-0.9.0/src/meerkat/textIDE.py +924 -0
  33. federate-0.9.0/src/meerkat/toolbox.py +2337 -0
federate-0.9.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 ROCK LAB PRIVATE LIMITED
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,15 @@
1
+ # Include Go source for building from sdist
2
+ recursive-include go *.go *.mod *.sum
3
+ include scripts/build_go.sh
4
+
5
+ # Include package data
6
+ recursive-include src/meerkat/bin *
7
+
8
+ # Exclude dev/test files
9
+ prune tests
10
+ prune venv
11
+ prune __pycache__
12
+ prune meerkat.build
13
+ global-exclude *.pyc
14
+ global-exclude *.pyo
15
+ global-exclude *.db
@@ -0,0 +1,143 @@
1
+ Metadata-Version: 2.4
2
+ Name: federate
3
+ Version: 0.9.0
4
+ Summary: A cross-platform terminal based p2p agent orchestration harness and universal automation system
5
+ Author-email: ROCK-LAB-PRIVATE-LIMITED <arkadeep_ghosh@rocklab.in>
6
+ License: Apache Software License
7
+ Project-URL: Homepage, https://github.com/ROCK-LAB-PRIVATE-LIMITED/federate.ai
8
+ Project-URL: Repository, https://github.com/ROCK-LAB-PRIVATE-LIMITED/federate.ai
9
+ Project-URL: Issues, https://github.com/ROCK-LAB-PRIVATE-LIMITED/federate.ai/issues
10
+ Keywords: ai,agent,tui,coding,llm
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Environment :: Console
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Software Development :: Libraries
21
+ Requires-Python: >=3.11
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: requests
25
+ Requires-Dist: textual>=0.40
26
+ Requires-Dist: langchain-openai
27
+ Requires-Dist: langchain-core
28
+ Requires-Dist: langgraph
29
+ Requires-Dist: rich
30
+ Requires-Dist: markdownify
31
+ Requires-Dist: markdown
32
+ Requires-Dist: tiktoken
33
+ Requires-Dist: beautifulsoup4
34
+ Requires-Dist: fake-useragent
35
+ Requires-Dist: numpy
36
+ Requires-Dist: pydantic
37
+ Requires-Dist: langgraph-checkpoint-sqlite
38
+ Requires-Dist: keyring
39
+ Requires-Dist: python-dotenv
40
+ Requires-Dist: pywinpty; platform_system == "Windows"
41
+ Provides-Extra: audio
42
+ Requires-Dist: sounddevice; extra == "audio"
43
+ Requires-Dist: kokoro-onnx; extra == "audio"
44
+ Requires-Dist: sherpa-onnx; extra == "audio"
45
+ Provides-Extra: telegram
46
+ Provides-Extra: browser
47
+ Requires-Dist: textual-serve; extra == "browser"
48
+ Provides-Extra: all
49
+ Requires-Dist: federate[audio,browser]; extra == "all"
50
+ Dynamic: license-file
51
+
52
+ # Federate.AI
53
+
54
+ Federate is a cross-platform, terminal-based **peer to peer** AI orchestration and universal automation system.
55
+
56
+ It turns your terminal into an interactive workbench where you can run specialized teams of AI agents who talk to and collaborate with each other, use voice input and output, execute desktop automation commands, and much more.
57
+
58
+ ---
59
+
60
+ ## Why We Built Federate
61
+
62
+ In many underprivileged regions of the developing world, owning a desktop computer is often a luxury, yet nearly everyone has access to a smartphone. Federate is written to bring the joy of programming to those pocket-sized screens. It is designed to run natively and comfortably inside **Termux on Android**, transforming a sub-$100 smartphone into a fully capable engineering workstation.
63
+
64
+ But Federate is also built for the most advanced power-users on high-end hardware. It runs on **any Mac or PC** you can throw at it, unlocking system-level features like desktop automation, local speech-to-text with hotword detection, and text-to-speech voice generation.
65
+
66
+ It is designed to be the ultimate equalizer: accessible to everyone, yet incredibly powerful for those with top-tier setups.
67
+
68
+ ---
69
+
70
+ ## What Makes Federate Different?
71
+
72
+ ### 1. Orchestration Freedom
73
+ Most multi-agent frameworks force you to write rigid, complex Python graphs and state-machine code to define how agents interact. Federate replaces this overhead with simple prompt driven system.
74
+
75
+ You organize your team of agents **simply by writing their backstories**. Describe how they relate to one another, and Federate builds the communication network dynamically. You can create:
76
+ * **A true Peer-to-Peer hierarchy where every agent is equal to every other agent.** This is the default and exclusive to Federate. No other agentic system does this as of date (2nd July 2026). We are the first to implement it (though many will likely follow suit).
77
+ * A strict corporate hierarchy or military style chain-of-command.
78
+ * A collaborative Hub-and-Spoke swarm.
79
+ * Anything else you can think of.
80
+
81
+ ### 2. Multi-Model, Cross-Provider Collaboration
82
+ Federate supports a true multi-model ecosystem. Because it abstracts the underlying LLM provider, you can bring different models into the same session. You can easily watch **ChatGPT and Gemini debate** a technical architecture decision, a code optimization, or a creative writing prompt directly inside your terminal window.
83
+
84
+ ### 3. Native Desktop Vision & Speech (Computer Only)
85
+ On desktop machines, agents can physically interact with your computer, listen for input and also talk back to you, using any model not just those with speech understanding or synthesis baked in.
86
+
87
+ ### 4. Pocket-Sized Software Engineering
88
+ Even on mobile, you can delegate complex multi-step coding tasks to an autonomous sub-agent. The system spawns an isolated local git worktree, writes and edits code, runs your local tests, and presents you with a clean commit diff to approve—ensuring your active development workspace remains untouched. Did you know your old Android can compile Rust?
89
+
90
+ ---
91
+
92
+ ## Feature Checklist
93
+
94
+ * **Context Injection (`&`):** Type `&` followed by a file or directory (e.g., `&src/app.py` or `&src/`) to instantly parse and inject that code directly into your prompt.
95
+ * **Direct Shell Passthrough (`!`):** Type `!` followed by a command (e.g., `!git diff`) to run it in your local workspace and feed the output to the AI.
96
+ * **Integrated Text IDE:** Press `F6` to instantly toggle between the chat view, a local file tree, a code editor with symbol outline, and an execution dashboard.
97
+ * **And a lot more:** Offline Persistent memory with semantic search, goal management, skills (passive and active skills, the latter again a Federate exclusive as on date), speech to text, text to speech, research orchestration, computer use, telegram integration, task scheduling etc already baked in, more features might be added in the future.
98
+ ---
99
+
100
+ ## Installation
101
+
102
+ Install the package via `pip`. We recommend installing with all optional extras to enable local voice/audio and serving capabilities:
103
+
104
+ ```bash
105
+ pip install "federate[all]"
106
+ ```
107
+ *(For a lightweight installation without audio or computer usage capabilities, run `pip install federate` instead on Termux and Raspberry Pi).*
108
+
109
+ ---
110
+
111
+ ## Quickstart
112
+
113
+ Start the application from your terminal:
114
+
115
+ ```bash
116
+ federate
117
+ ```
118
+ *(You can also open a specific project directory directly: `federate path/to/folder`)*
119
+
120
+ ### Basic Setup
121
+ 1. Once the interface loads, press **`F4`** to open the **Agent Editor**.
122
+ 2. Set up your active agent, including your API keys and model choices (Federate is pre-configured for OpenRouter, but works with any OpenAI-compatible API).
123
+ 3. Federate will securely encrypt and save your credentials inside your native OS keychain.
124
+
125
+ ### Changing Safety Modes (`Ctrl+T` / `/arm`)
126
+ To protect your workspace, the system boots in **SAFE (PLAN)** mode. In this mode, agents can search the web and read files, but they cannot edit code, run terminal commands, or control your computer.
127
+ * Press **`Ctrl+T`** or type **`/arm`** to cycle permissions:
128
+ * **SAFE (PLAN):** Read-only. Great for planning and research.
129
+ * **SEMI-AUTO:** Agents can edit and execute, but Federate will present a popup asking you to approve every single tool execution.
130
+ * **FULL-AUTO:** Agents can run autonomous toolchains in the background.
131
+
132
+ ### Command Reference
133
+ * **Inject Files:** Type `&` followed by the file path (e.g., `&src/main.py`). Use **`UP/DOWN`** arrow keys to cycle through autocomplete suggestions.
134
+ * **Mention Agents:** Type `@` followed by the agent name to route your message to a specific agent. Use `@team` to broadcast to everyone, or `@room` to talk to agents active in the current session. **Agents can also use @ to invoke other agents,** which is the core of the peer to peer system.
135
+ * **Key Bindings:**
136
+ * **`F2`**: Session Manager (Create a new chat or load historical multi-agent sessions)
137
+ * **`F4`**: Open the Active Agent configuration
138
+ * **`F5`**: Cycle the host agent
139
+ * **`F6`**: Cycle through UI panels (Chat ↔ IDE Editor ↔ Executions Dashboard)
140
+ * **`F8`**: Change your workspace directory
141
+ * **`Ctrl+K`**: Wipe the memory of all agents
142
+ * **`Ctrl+A`**: **ABORT** (Emergency stop for any running AI tasks or terminal commands)
143
+ * **`Ctrl+Q`**: Quit Federate
@@ -0,0 +1,92 @@
1
+ # Federate.AI
2
+
3
+ Federate is a cross-platform, terminal-based **peer to peer** AI orchestration and universal automation system.
4
+
5
+ It turns your terminal into an interactive workbench where you can run specialized teams of AI agents who talk to and collaborate with each other, use voice input and output, execute desktop automation commands, and much more.
6
+
7
+ ---
8
+
9
+ ## Why We Built Federate
10
+
11
+ In many underprivileged regions of the developing world, owning a desktop computer is often a luxury, yet nearly everyone has access to a smartphone. Federate is written to bring the joy of programming to those pocket-sized screens. It is designed to run natively and comfortably inside **Termux on Android**, transforming a sub-$100 smartphone into a fully capable engineering workstation.
12
+
13
+ But Federate is also built for the most advanced power-users on high-end hardware. It runs on **any Mac or PC** you can throw at it, unlocking system-level features like desktop automation, local speech-to-text with hotword detection, and text-to-speech voice generation.
14
+
15
+ It is designed to be the ultimate equalizer: accessible to everyone, yet incredibly powerful for those with top-tier setups.
16
+
17
+ ---
18
+
19
+ ## What Makes Federate Different?
20
+
21
+ ### 1. Orchestration Freedom
22
+ Most multi-agent frameworks force you to write rigid, complex Python graphs and state-machine code to define how agents interact. Federate replaces this overhead with simple prompt driven system.
23
+
24
+ You organize your team of agents **simply by writing their backstories**. Describe how they relate to one another, and Federate builds the communication network dynamically. You can create:
25
+ * **A true Peer-to-Peer hierarchy where every agent is equal to every other agent.** This is the default and exclusive to Federate. No other agentic system does this as of date (2nd July 2026). We are the first to implement it (though many will likely follow suit).
26
+ * A strict corporate hierarchy or military style chain-of-command.
27
+ * A collaborative Hub-and-Spoke swarm.
28
+ * Anything else you can think of.
29
+
30
+ ### 2. Multi-Model, Cross-Provider Collaboration
31
+ Federate supports a true multi-model ecosystem. Because it abstracts the underlying LLM provider, you can bring different models into the same session. You can easily watch **ChatGPT and Gemini debate** a technical architecture decision, a code optimization, or a creative writing prompt directly inside your terminal window.
32
+
33
+ ### 3. Native Desktop Vision & Speech (Computer Only)
34
+ On desktop machines, agents can physically interact with your computer, listen for input and also talk back to you, using any model not just those with speech understanding or synthesis baked in.
35
+
36
+ ### 4. Pocket-Sized Software Engineering
37
+ Even on mobile, you can delegate complex multi-step coding tasks to an autonomous sub-agent. The system spawns an isolated local git worktree, writes and edits code, runs your local tests, and presents you with a clean commit diff to approve—ensuring your active development workspace remains untouched. Did you know your old Android can compile Rust?
38
+
39
+ ---
40
+
41
+ ## Feature Checklist
42
+
43
+ * **Context Injection (`&`):** Type `&` followed by a file or directory (e.g., `&src/app.py` or `&src/`) to instantly parse and inject that code directly into your prompt.
44
+ * **Direct Shell Passthrough (`!`):** Type `!` followed by a command (e.g., `!git diff`) to run it in your local workspace and feed the output to the AI.
45
+ * **Integrated Text IDE:** Press `F6` to instantly toggle between the chat view, a local file tree, a code editor with symbol outline, and an execution dashboard.
46
+ * **And a lot more:** Offline Persistent memory with semantic search, goal management, skills (passive and active skills, the latter again a Federate exclusive as on date), speech to text, text to speech, research orchestration, computer use, telegram integration, task scheduling etc already baked in, more features might be added in the future.
47
+ ---
48
+
49
+ ## Installation
50
+
51
+ Install the package via `pip`. We recommend installing with all optional extras to enable local voice/audio and serving capabilities:
52
+
53
+ ```bash
54
+ pip install "federate[all]"
55
+ ```
56
+ *(For a lightweight installation without audio or computer usage capabilities, run `pip install federate` instead on Termux and Raspberry Pi).*
57
+
58
+ ---
59
+
60
+ ## Quickstart
61
+
62
+ Start the application from your terminal:
63
+
64
+ ```bash
65
+ federate
66
+ ```
67
+ *(You can also open a specific project directory directly: `federate path/to/folder`)*
68
+
69
+ ### Basic Setup
70
+ 1. Once the interface loads, press **`F4`** to open the **Agent Editor**.
71
+ 2. Set up your active agent, including your API keys and model choices (Federate is pre-configured for OpenRouter, but works with any OpenAI-compatible API).
72
+ 3. Federate will securely encrypt and save your credentials inside your native OS keychain.
73
+
74
+ ### Changing Safety Modes (`Ctrl+T` / `/arm`)
75
+ To protect your workspace, the system boots in **SAFE (PLAN)** mode. In this mode, agents can search the web and read files, but they cannot edit code, run terminal commands, or control your computer.
76
+ * Press **`Ctrl+T`** or type **`/arm`** to cycle permissions:
77
+ * **SAFE (PLAN):** Read-only. Great for planning and research.
78
+ * **SEMI-AUTO:** Agents can edit and execute, but Federate will present a popup asking you to approve every single tool execution.
79
+ * **FULL-AUTO:** Agents can run autonomous toolchains in the background.
80
+
81
+ ### Command Reference
82
+ * **Inject Files:** Type `&` followed by the file path (e.g., `&src/main.py`). Use **`UP/DOWN`** arrow keys to cycle through autocomplete suggestions.
83
+ * **Mention Agents:** Type `@` followed by the agent name to route your message to a specific agent. Use `@team` to broadcast to everyone, or `@room` to talk to agents active in the current session. **Agents can also use @ to invoke other agents,** which is the core of the peer to peer system.
84
+ * **Key Bindings:**
85
+ * **`F2`**: Session Manager (Create a new chat or load historical multi-agent sessions)
86
+ * **`F4`**: Open the Active Agent configuration
87
+ * **`F5`**: Cycle the host agent
88
+ * **`F6`**: Cycle through UI panels (Chat ↔ IDE Editor ↔ Executions Dashboard)
89
+ * **`F8`**: Change your workspace directory
90
+ * **`Ctrl+K`**: Wipe the memory of all agents
91
+ * **`Ctrl+A`**: **ABORT** (Emergency stop for any running AI tasks or terminal commands)
92
+ * **`Ctrl+Q`**: Quit Federate