osagent 0.1.40 → 0.1.42

package/LICENSE

@@ -0,0 +1,73 @@
+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 2025 OSA
+
+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.

package/README.md

@@ -0,0 +1,310 @@
+# OS Agent
+
+An AI-powered autonomous coding assistant CLI that runs locally with Ollama or connects to cloud AI providers. Built for developers who want full control over their AI coding assistant.
+
+## Features
+
+- **Local-first AI**: Works with Ollama for completely private, offline usage
+- **Cloud support**: Connect to Ollama Cloud or OpenAI-compatible APIs
+- **Interactive CLI**: Beautiful terminal interface with monochrome green theme
+- **Autonomous coding**: Generate, edit, and refactor code with natural language
+- **Multi-file editing**: Make changes across your entire project
+- **Git integration**: Automatic commits and PR creation
+- **Consultation mode**: AI asks clarifying questions to better understand your needs
+- **Conversation persistence**: Resume previous sessions with `/continue`
+- **System health checks**: Built-in diagnostics with `/doctor`
+- **Extensible**: MCP (Model Context Protocol) support for custom tools
+- **Custom agents**: Define your own specialized agents in `~/.osagent/agents/`
+- **Custom commands**: Create custom slash commands in `~/.osagent/commands/`
+- **Custom skills**: Create skill plugins for multi-step workflows
+- **Vector memory**: Semantic search over session history with ChromaDB
+- **Embeddings**: Ollama embeddings with OpenRouter fallback
+- **Advanced hooks**: 12 subagent hooks for lifecycle, memory, and skill events
+
+## Installation
+
+### From npm (recommended)
+
+```bash
+npm install -g osagent
+```
+
+### From source
+
+```bash
+git clone https://github.com/robertohluna/osagent.git
+cd osagent
+npm install
+npm run build
+npm link
+```
+
+## Quick Start
+
+### Option 1: Use with Ollama (Local - Recommended)
+
+1. Install [Ollama](https://ollama.com)
+2. Pull a coding model:
+   ```bash
+   ollama pull qwen2.5-coder:32b
+   ```
+3. Run OS Agent:
+   ```bash
+   osagent
+   ```
+
+### Option 2: Use with Ollama Cloud
+
+1. Get an API key from [Ollama Cloud](https://ollama.com)
+2. Set your API key:
+   ```bash
+   export OLLAMA_API_KEY=your-api-key
+   ```
+3. Run OS Agent:
+   ```bash
+   osagent
+   ```
+
+### Option 3: Use with OpenAI-compatible APIs
+
+```bash
+osagent --auth openai
+```
+
+## Usage
+
+### Basic Commands
+
+```bash
+# Start interactive mode
+osagent
+
+# Start with a prompt
+osagent "Explain this codebase"
+
+# Use a specific model
+osagent --model qwen2.5-coder:32b
+
+# Resume last conversation
+osagent --continue
+
+# Print a file and ask about it
+osagent "What does this do?" < src/main.ts
+
+# Run health check
+osagent doctor
+
+# Dangerous mode (auto-accept all tool executions)
+osagent --dangerously
+```
+
+### Slash Commands
+
+Once in the interactive mode, you can use these commands:
+
+#### General
+- `/help` - Show available commands
+- `/about` - Show version and system info
+- `/settings` - View and edit settings
+- `/quit` or `/q` - Exit OS Agent
+
+#### Model & AI
+- `/model` - Switch AI model (supports local Ollama models)
+- `/agents` - Manage custom agents
+- `/consult` - Toggle consultation mode (AI asks clarifying questions)
+
+#### Conversation
+- `/continue` - Resume the most recent conversation
+- `/continue list` - List recent sessions to resume
+- `/reset` - Clear conversation and start fresh
+- `/clear` - Clear the screen
+- `/chat save <tag>` - Save conversation checkpoint
+- `/chat resume <tag>` - Resume from checkpoint
+
+#### Safety & Permissions
+- `/dangerously` or `/yolo` - Toggle auto-accept mode for tool executions
+- `/permissions` - View and manage tool permissions
+
+#### System
+- `/doctor` - Check system health and updates
+- `/doctor update` - Auto-update to latest version
+- `/doctor init` - Initialize `~/.osagent/` directory structure
+- `/view` - View system architecture and configuration
+- `/view config` - Current configuration
+- `/view files` - Configuration files
+- `/view models` - Supported models
+- `/context` or `/ctx` - View context window usage and token stats
+
+#### Utilities
+- `/copy` - Copy last response to clipboard
+- `/memory` - View and edit project memory
+- `/tools` - List available tools
+- `/mcp` - Manage MCP servers
+
+### Status Bar
+
+While OS Agent works, you'll see a real-time status bar showing:
+- Current activity with spinner
+- Token usage (input ↑ / output ↓)
+- Elapsed time
+- Task progress and list
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ ◐ Writing tests for auth module... (2/5)    ↑12.3k ↓8.2k 2m 15s │
+│ ├─ ○ Create test file                                   │
+│ ├─ ◐ Writing unit tests                                │
+│ └─ ○ Run tests and fix errors                          │
+└─────────────────────────────────────────────────────────┘
+```
+
+### Consultation Mode
+
+OS Agent can ask you clarifying questions as it works to better understand your requirements:
+
+```bash
+/consult on        # Active mode - questions shown while agent works
+/consult blocking  # Blocking mode - high-priority questions pause the agent
+/consult off       # Disable consultation
+/consult context   # View collected context
+```
+
+Questions appear in a dedicated panel below the status bar during agent operations.
+
+### Vector Memory (Optional)
+
+For semantic search over session history, start ChromaDB:
+
+```bash
+# Start ChromaDB with Docker
+docker compose -f docker/docker-compose.yml up -d
+
+# Ensure Ollama has the embedding model
+ollama pull nomic-embed-text
+```
+
+### Configuration
+
+OS Agent stores its configuration in `~/.osagent/`:
+
+```
+~/.osagent/
+├── settings.json       # User settings
+├── agents/            # Custom agent definitions (.md, .yaml, .json)
+├── commands/          # Custom slash commands (.toml)
+├── skills/            # Custom skill plugins (.yaml)
+├── prompts/           # Custom prompts
+├── episodes/          # Episodic memory storage
+└── system.md          # Custom system prompt
+```
+
+### Custom Agents
+
+Create custom agents in `~/.osagent/agents/`:
+
+```yaml
+# ~/.osagent/agents/my-agent.yaml
+name: my-agent
+description: A specialized agent for my use case
+systemPrompt: You are an expert in...
+model: qwen2.5-coder:32b
+```
+
+### Project Memory
+
+Create an `OSAGENT.md` file in your project root to give OS Agent context:
+
+```bash
+osagent /init
+```
+
+## Supported Models
+
+### Cloud Models (Ollama Cloud)
+- `qwen3-coder:480b-cloud` - Most powerful (256K context)
+- `qwen3-coder:30b` - Efficient (30B params, 3.3B active)
+
+### Local Models (Ollama)
+- `qwen2.5-coder:32b` - Best local coding model (~20GB VRAM)
+- `qwen2.5-coder:14b` - Great balance (~10GB VRAM)
+- `qwen2.5-coder:7b` - Good for limited VRAM (~5GB)
+- `codellama:34b` - Meta's coding model
+- `deepseek-coder-v2:16b` - Efficient MoE model
+- `llama3.2:latest` - General purpose
+
+## Requirements
+
+- Node.js >= 20.0.0
+- Ollama (for local usage) or API key for cloud providers
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build all packages
+npm run build
+
+# Run in development mode
+npm run start
+
+# Run tests
+npm run test
+
+# Type check
+npm run typecheck
+
+# Lint
+npm run lint
+```
+
+## Architecture
+
+OS Agent is a monorepo with the following packages:
+
+```
+packages/
+├── cli/          # Terminal UI and user interaction (React/Ink)
+├── core/         # AI engine, tools, and services
+├── test-utils/   # Shared test utilities
+└── vscode-ide-companion/  # VS Code extension
+```
+
+## Keyboard Shortcuts
+
+### General
+- `Ctrl+C` - Cancel current operation / Exit (press twice)
+- `Ctrl+D` - Exit
+- `Escape` - Cancel operation / Clear input
+- `Tab` - Autocomplete commands
+- `Up/Down` - Navigate history
+- `?` - Show shortcuts help
+
+### During Operations
+- `Ctrl+O` - Expand/collapse output
+- `Ctrl+Y` - Toggle todo list visibility
+- `Ctrl+E` - Toggle agent detail level
+- `Ctrl+F` - Focus embedded shell
+
+### Text Editing
+- `Ctrl+L` - Clear screen
+- `Ctrl+A` - Move to start of line
+- `Ctrl+E` - Move to end of line
+- `Ctrl+K` - Delete to end of line
+- `Ctrl+U` - Delete to start of line
+- `Shift+Enter` - Insert newline
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines before submitting PRs.
+
+## Links
+
+- [GitHub](https://github.com/robertohluna/osagent)
+- [npm](https://www.npmjs.com/package/osagent)
+- [Issues](https://github.com/robertohluna/osagent/issues)