federaide-dev-nightly 1.2.17__tar.gz

federaide_dev_nightly-1.2.17/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ROCK LAB PRIVATE LIMITED
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

federaide_dev_nightly-1.2.17/MANIFEST.in

@@ -0,0 +1,15 @@
+# Include Go source for building from sdist
+recursive-include go *.go *.mod *.sum
+include scripts/build_go.sh
+
+# Include package data
+recursive-include src/meerkat/bin *
+
+# Exclude dev/test files
+prune tests
+prune venv
+prune __pycache__
+prune meerkat.build
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude *.db

federaide_dev_nightly-1.2.17/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: federaide-dev-nightly
+Version: 1.2.17
+Summary: A cross-platform terminal based p2p agent orchestration harness and universal automation system
+Author-email: ROCK-LAB-PRIVATE-LIMITED <arkadeep_ghosh@rocklab.in>
+License: Apache Software License
+Project-URL: Homepage, https://federaide.rocklab.in
+Project-URL: Repository, https://github.com/ROCK-LAB-PRIVATE-LIMITED/federaide
+Project-URL: Issues, https://github.com/ROCK-LAB-PRIVATE-LIMITED/federaide/issues
+Keywords: ai,agent,tui,coding,llm
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests==2.34.2
+Requires-Dist: textual==8.2.7
+Requires-Dist: langchain-core>=1.4.8
+Requires-Dist: langchain-openai>=1.3.2
+Requires-Dist: langgraph>=1.1.10
+Requires-Dist: langgraph-checkpoint>=4.1.1
+Requires-Dist: langgraph-checkpoint-sqlite>=3.1.0
+Requires-Dist: langgraph-prebuilt>=1.0.13
+Requires-Dist: langgraph-sdk>=0.3.15
+Requires-Dist: langsmith>=0.7.22
+Requires-Dist: rich==15.0.0
+Requires-Dist: markdownify==1.2.2
+Requires-Dist: markdown==3.10.2
+Requires-Dist: tiktoken
+Requires-Dist: beautifulsoup4==4.15.0
+Requires-Dist: fake-useragent==2.2.0
+Requires-Dist: numpy==2.4.6
+Requires-Dist: pydantic==2.13.4
+Requires-Dist: keyring>=25.7.0
+Requires-Dist: DDGS>=9.12.0
+Requires-Dist: pycryptodome>=3.23.0
+Requires-Dist: pylatexenc==2.10
+Requires-Dist: pyperclip==1.11.0
+Requires-Dist: curl-cffi==0.15.0
+Requires-Dist: pypdfium2
+Requires-Dist: pywinpty; platform_system == "Windows"
+Provides-Extra: audio
+Requires-Dist: sounddevice; extra == "audio"
+Requires-Dist: kokoro-onnx; extra == "audio"
+Requires-Dist: sherpa-onnx; extra == "audio"
+Provides-Extra: vision
+Requires-Dist: pyautogui; extra == "vision"
+Requires-Dist: pillow; extra == "vision"
+Provides-Extra: pdf
+Requires-Dist: weasyprint; extra == "pdf"
+Requires-Dist: pypdf; extra == "pdf"
+Provides-Extra: telegram
+Provides-Extra: ide
+Requires-Dist: tree-sitter; extra == "ide"
+Requires-Dist: tree-sitter-python; extra == "ide"
+Requires-Dist: tree-sitter-c; extra == "ide"
+Requires-Dist: tree-sitter-rust; extra == "ide"
+Requires-Dist: tree-sitter-go; extra == "ide"
+Requires-Dist: tree-sitter-cpp; extra == "ide"
+Provides-Extra: all
+Requires-Dist: federate[audio,ide,pdf,vision]; extra == "all"
+Dynamic: license-file
+
+# FEDERaiDE
+
+This is the Dev Branch.
+FEDERaiDE is a cross-platform, terminal-based **peer to peer** AI orchestration harness and universal automation system. 
+
+It turns your terminal into an interactive workbench where you can run a specialized team of AI agents who talk to and collaborate with each other, use voice input and output, execute desktop automation commands, and much more.
+
+---
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/landing/assets/federaide_logo.webp" alt="FEDERaiDE Logo" width="100%" />
+</p>
+
+## What Makes FEDERaiDE Different?
+
+### 1. Orchestration Freedom
+You organize your team of agents **simply by writing their backstories**. Describe how they relate to one another, and FEDERaiDE builds the communication network dynamically. You can create:
+* **A true Peer-to-Peer hierarchy where every agent is equal to every other agent.** This is the default and exclusive to FEDERaiDE. 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).
+* A strict corporate hierarchy or military style chain-of-command.
+* A collaborative Hub-and-Spoke swarm.
+* Anything else you can think of.
+
+FEDERaiDE 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.
+
+### 2. Active Skills
+While we support markdown based skills, FEDERaiDE debuts the 'active skill' system where actual programs are stored and executed by agents on demand. This allows automation of almost anything you can think of. There is Visual Computer Usage ability for automating tasks requiring GUI interaction.
+
+### 3. Native Desktop Vision & Speech
+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). Speech to text with hotword detection results in true hands free operation. Text to speech with different voice for each agent results in immerrssive role-play.
+
+### 4. First Class support for Termux
+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?
+
+---
+
+## Feature Checklist
+
+* **File and Folder attachments (`&`):** Type `&` followed by a file or directory (e.g., `&src/app.py` or `&src/`) to attach that file or folder directly into your prompt.
+* **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.
+* **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.
+* **And a lot more:** Offline Persistent memory with semantic search, goal management, skills (passive and active skills, the latter again a FEDERaiDE exclusive as on date), speech to text, text to speech, deep research with illustrated pdf generation, computer use, telegram integration, task scheduling etc already baked in, more features might be added in the future.
+---
+
+## Installation
+
+Mac/Android(Termux):
+```bash
+curl https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/install.sh | bash
+```
+
+Windows:
+```powershell
+irm https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/install.ps1 | iex
+```
+
+Linux:
+```powershell
+wget -O- https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/nuxinstall.sh | sh
+```
+
+Via `uv`:
+```bash
+uv tool install federaide
+```
+Via `pipx`:
+```bash
+pipx install federaide
+```
+
+You can also install the package via `pip`. We recommend installing with all optional extras to enable local voice/audio and IDE capabilities:
+```bash
+pip install "federaide[all]"
+```
+*(For a lightweight installation without audio or computer usage capabilities, run `pip install federaide`).*
+
+---
+
+## Update
+
+Mac/Linux/Android(Termux):
+```bash
+curl https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/update.sh | bash
+```
+
+Windows:
+```powershell
+irm https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/update.ps1 | iex
+```
+
+---
+
+## Uninstall
+
+Mac/Linux/Android(Termux):
+```bash
+curl https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/uninstall.sh | bash
+```
+
+Windows:
+```powershell
+irm https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/uninstall.ps1 | iex
+```
+
+---
+
+## Quickstart
+
+Start the application from your terminal:
+
+```bash
+federaide
+```
+*(You can also open the last available chat using federaide -r)*
+
+### Basic Setup
+1. On the first run of FEDERaiDE, you will be presented with an onboarding popup that will help you setup your first agent.
+2. Set up your active agent, including your API keys and model choices (FEDERaiDE is pre-configured for OpenRouter, but works with any OpenAI-compatible API). 
+3. FEDERaiDE will securely encrypt and save your credentials inside your native OS keychain.
+
+### Changing Safety Modes (`Ctrl+T`)
+To protect your workspace, the system boots in **SAFE** mode. You can use /tools command to check what tools are available and activated at any time for the current agent.
+* Press **`Ctrl+T`** to cycle permissions:
+  * **SAFE:** Agents can only call basic tools (web search, deep research and list files). You can authorize more tools in safe mode on a per-agent basis but they will still present a confirmation popup.
+  * **SEMI-AUTO:** Agents can edit and execute, but FEDERaiDE will present a popup asking you to approve every single tool execution.
+  * **FULL-AUTO:** Agents can run any and every tool available. No confirmation will be required.
+
+### Command Reference
+* **Attach Files and Folders:** Type `&` followed by the file path (e.g., `&src/main.py`). Use **`UP/DOWN`** arrow keys to cycle through autocomplete suggestions.
+* **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.
+* **Slash Commands:** Type / followed by the command. For /help the full list of available commands and their descriptions.
+* **Key Bindings:**
+  * **`F2`**: Session Manager (Create a new chat or load historical multi-agent sessions)
+  * **`F4`**: Open the Active Agent's configuration
+  * **`F5`**: Change Agent and set the default agent
+  * **`F6`**: Cycle through UI panels (Chat ↔ IDE Editor ↔ Executions Dashboard)
+  * **`F8`**: Change your workspace directory
+  * **`Ctrl+K`**: Start fresh conversation
+  * **`Ctrl+A`**: **ABORT** (Emergency stop for any running AI tasks or terminal commands)
+  * **`Ctrl+Q`**: Quit FEDERaiDE
+
+### Disclaimer
+* All AI systems inherently navigate a trade-off between capability and safety; **FEDERaiDE leans heavily toward the capability aspect.** For safe and secure coding with AI assistance, please consider using [***KittySuite IDE***](https://www.rocklab.in/kittysuite), where the AI does not have the capability to execute code, run commands, or read files you don't explicitly share.
+
+## Roadmap & Upcoming Features:
+  * Image generation (much requested feature)
+  * Email integration (check inbox/read email/write email)
+  * Integrated Secrets Management for Active Skills
+  * Seperate package for nightlies
+  
+## Why We Built FEDERaiDE
+
+In many regions of the developing world, owning a desktop computer is often a luxury, a lot more people have access to smartphones. FEDERaiDE is written to bring the joy of programming to as many people as possible, by being as device agnostic as possible. It is designed to run natively and comfortably inside **Termux on Android**, transforming a spare smartphone into a fully capable engineering workstation.
+
+FEDERaiDE is also built for 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. 
+
+It is designed to be accessible by everyone, while being incredibly powerful.
+
+---

federaide_dev_nightly-1.2.17/README.md

@@ -0,0 +1,157 @@
+# FEDERaiDE
+
+This is the Dev Branch.
+FEDERaiDE is a cross-platform, terminal-based **peer to peer** AI orchestration harness and universal automation system. 
+
+It turns your terminal into an interactive workbench where you can run a specialized team of AI agents who talk to and collaborate with each other, use voice input and output, execute desktop automation commands, and much more.
+
+---
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/landing/assets/federaide_logo.webp" alt="FEDERaiDE Logo" width="100%" />
+</p>
+
+## What Makes FEDERaiDE Different?
+
+### 1. Orchestration Freedom
+You organize your team of agents **simply by writing their backstories**. Describe how they relate to one another, and FEDERaiDE builds the communication network dynamically. You can create:
+* **A true Peer-to-Peer hierarchy where every agent is equal to every other agent.** This is the default and exclusive to FEDERaiDE. 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).
+* A strict corporate hierarchy or military style chain-of-command.
+* A collaborative Hub-and-Spoke swarm.
+* Anything else you can think of.
+
+FEDERaiDE 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.
+
+### 2. Active Skills
+While we support markdown based skills, FEDERaiDE debuts the 'active skill' system where actual programs are stored and executed by agents on demand. This allows automation of almost anything you can think of. There is Visual Computer Usage ability for automating tasks requiring GUI interaction.
+
+### 3. Native Desktop Vision & Speech
+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). Speech to text with hotword detection results in true hands free operation. Text to speech with different voice for each agent results in immerrssive role-play.
+
+### 4. First Class support for Termux
+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?
+
+---
+
+## Feature Checklist
+
+* **File and Folder attachments (`&`):** Type `&` followed by a file or directory (e.g., `&src/app.py` or `&src/`) to attach that file or folder directly into your prompt.
+* **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.
+* **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.
+* **And a lot more:** Offline Persistent memory with semantic search, goal management, skills (passive and active skills, the latter again a FEDERaiDE exclusive as on date), speech to text, text to speech, deep research with illustrated pdf generation, computer use, telegram integration, task scheduling etc already baked in, more features might be added in the future.
+---
+
+## Installation
+
+Mac/Android(Termux):
+```bash
+curl https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/install.sh | bash
+```
+
+Windows:
+```powershell
+irm https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/install.ps1 | iex
+```
+
+Linux:
+```powershell
+wget -O- https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/nuxinstall.sh | sh
+```
+
+Via `uv`:
+```bash
+uv tool install federaide
+```
+Via `pipx`:
+```bash
+pipx install federaide
+```
+
+You can also install the package via `pip`. We recommend installing with all optional extras to enable local voice/audio and IDE capabilities:
+```bash
+pip install "federaide[all]"
+```
+*(For a lightweight installation without audio or computer usage capabilities, run `pip install federaide`).*
+
+---
+
+## Update
+
+Mac/Linux/Android(Termux):
+```bash
+curl https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/update.sh | bash
+```
+
+Windows:
+```powershell
+irm https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/update.ps1 | iex
+```
+
+---
+
+## Uninstall
+
+Mac/Linux/Android(Termux):
+```bash
+curl https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/uninstall.sh | bash
+```
+
+Windows:
+```powershell
+irm https://raw.githubusercontent.com/ROCK-LAB-PRIVATE-LIMITED/federaide/main/uninstall.ps1 | iex
+```
+
+---
+
+## Quickstart
+
+Start the application from your terminal:
+
+```bash
+federaide
+```
+*(You can also open the last available chat using federaide -r)*
+
+### Basic Setup
+1. On the first run of FEDERaiDE, you will be presented with an onboarding popup that will help you setup your first agent.
+2. Set up your active agent, including your API keys and model choices (FEDERaiDE is pre-configured for OpenRouter, but works with any OpenAI-compatible API). 
+3. FEDERaiDE will securely encrypt and save your credentials inside your native OS keychain.
+
+### Changing Safety Modes (`Ctrl+T`)
+To protect your workspace, the system boots in **SAFE** mode. You can use /tools command to check what tools are available and activated at any time for the current agent.
+* Press **`Ctrl+T`** to cycle permissions:
+  * **SAFE:** Agents can only call basic tools (web search, deep research and list files). You can authorize more tools in safe mode on a per-agent basis but they will still present a confirmation popup.
+  * **SEMI-AUTO:** Agents can edit and execute, but FEDERaiDE will present a popup asking you to approve every single tool execution.
+  * **FULL-AUTO:** Agents can run any and every tool available. No confirmation will be required.
+
+### Command Reference
+* **Attach Files and Folders:** Type `&` followed by the file path (e.g., `&src/main.py`). Use **`UP/DOWN`** arrow keys to cycle through autocomplete suggestions.
+* **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.
+* **Slash Commands:** Type / followed by the command. For /help the full list of available commands and their descriptions.
+* **Key Bindings:**
+  * **`F2`**: Session Manager (Create a new chat or load historical multi-agent sessions)
+  * **`F4`**: Open the Active Agent's configuration
+  * **`F5`**: Change Agent and set the default agent
+  * **`F6`**: Cycle through UI panels (Chat ↔ IDE Editor ↔ Executions Dashboard)
+  * **`F8`**: Change your workspace directory
+  * **`Ctrl+K`**: Start fresh conversation
+  * **`Ctrl+A`**: **ABORT** (Emergency stop for any running AI tasks or terminal commands)
+  * **`Ctrl+Q`**: Quit FEDERaiDE
+
+### Disclaimer
+* All AI systems inherently navigate a trade-off between capability and safety; **FEDERaiDE leans heavily toward the capability aspect.** For safe and secure coding with AI assistance, please consider using [***KittySuite IDE***](https://www.rocklab.in/kittysuite), where the AI does not have the capability to execute code, run commands, or read files you don't explicitly share.
+
+## Roadmap & Upcoming Features:
+  * Image generation (much requested feature)
+  * Email integration (check inbox/read email/write email)
+  * Integrated Secrets Management for Active Skills
+  * Seperate package for nightlies
+  
+## Why We Built FEDERaiDE
+
+In many regions of the developing world, owning a desktop computer is often a luxury, a lot more people have access to smartphones. FEDERaiDE is written to bring the joy of programming to as many people as possible, by being as device agnostic as possible. It is designed to run natively and comfortably inside **Termux on Android**, transforming a spare smartphone into a fully capable engineering workstation.
+
+FEDERaiDE is also built for 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. 
+
+It is designed to be accessible by everyone, while being incredibly powerful.
+
+---