|
1 | 1 | <div align="center"> |
2 | | -<h1>Seawolf</h1> |
3 | | -<p>An AI-powered autonomous coding agent for your editor</p> |
| 2 | +<h1>🐺 Seawolf</h1> |
| 3 | +<p>⚡ An AI-powered autonomous coding agent for your editor ⚡</p> |
4 | 4 | </div> |
5 | 5 |
|
6 | | -**Seawolf** is an AI-powered autonomous coding agent that lives in your editor. It can: |
| 6 | +## 🛠 What is Seawolf? |
7 | 7 |
|
8 | | -- Communicate in natural language |
9 | | -- Read and write files directly in your workspace |
10 | | -- Run terminal commands |
11 | | -- Automate browser actions |
12 | | -- Integrate with any OpenAI-compatible or custom API/model |
13 | | -- Adapt its capabilities through **Custom Modes** |
| 8 | +**Seawolf** is an AI-powered autonomous coding agent that seamlessly integrates with your editor to supercharge your development workflow. It can: |
14 | 9 |
|
15 | | -Whether you are seeking a flexible coding partner, a system architect, or specialized roles like a QA engineer or product manager, Seawolf can help you build software more efficiently. |
| 10 | +- 🗣 **Communicate in natural language** – Describe what you need, and Seawolf gets to work! |
| 11 | +- 📂 **Read & write files** directly in your workspace – No more switching between windows. |
| 12 | +- 💻 **Run terminal commands** – Automate CLI tasks effortlessly. |
| 13 | +- 🌐 **Automate browser actions** – Web testing and automation made easy. |
| 14 | +- 🧠 **Integrate with OpenAI-compatible or custom AI models** – Use the best AI for your needs. |
| 15 | +- 🏗 **Adapt through Custom Modes** – Define specialized roles like a QA engineer, system architect, or security auditor. |
16 | 16 |
|
17 | | -Check out the [CHANGELOG](CHANGELOG.md) for detailed updates and fixes. |
| 17 | +Whether you need a **flexible coding assistant, a system architect, or an automation powerhouse**, Seawolf is designed to help you build software faster and smarter! ⚡🐺 |
18 | 18 |
|
19 | | ---- |
20 | | - |
21 | | -## What Can Seawolf Do? |
22 | | - |
23 | | -- **Generate Code** from natural language descriptions |
24 | | -- **Refactor & Debug** existing code |
25 | | -- **Write & Update** documentation |
26 | | -- **Answer Questions** about your codebase |
27 | | -- **Automate** repetitive tasks |
28 | | -- **Create** new files and projects |
29 | | - |
30 | | -## Quick Start |
31 | | - |
32 | | -1. Install Seawolf from the VS Code Marketplace |
33 | | -2. Connect your preferred AI provider |
34 | | -3. Start your first task |
35 | | - |
36 | | -## Key Features |
37 | | - |
38 | | -### Multiple Modes |
39 | | - |
40 | | -Seawolf adapts to your needs with specialized modes: |
| 19 | +🔄 Check out the [CHANGELOG](CHANGELOG.md) for the latest updates and improvements! |
41 | 20 |
|
42 | | -- **Code Mode:** For general-purpose coding tasks |
43 | | -- **Architect Mode:** For planning and technical leadership |
44 | | -- **Ask Mode:** For answering questions and providing information |
45 | | -- **Debug Mode:** For systematic problem diagnosis |
46 | | -- **Custom Modes:** Create unlimited specialized personas for security auditing, performance optimization, documentation, or any other task |
| 21 | +--- |
47 | 22 |
|
48 | | -### Smart Tools |
| 23 | +## 🚀 What Can Seawolf Do? |
49 | 24 |
|
50 | | -Seawolf comes with powerful tools that can: |
| 25 | +Seawolf isn't just another AI assistant—it’s an **autonomous agent** designed to make software development effortless. Here’s what it can do: |
51 | 26 |
|
52 | | -- Read and write files in your project |
53 | | -- Execute commands in your VS Code terminal |
54 | | -- Control a web browser |
55 | | -- Use external tools via MCP (Model Context Protocol) |
| 27 | +- ✨ **Generate Code** – Write complete functions, classes, or entire apps from natural language descriptions. |
| 28 | +- 🔧 **Refactor & Debug** – Identify issues, optimize your code, and fix bugs autonomously. |
| 29 | +- 📖 **Write & Update Documentation** – Keep your codebase well-documented with minimal effort. |
| 30 | +- ❓ **Answer Questions** – Get insights into your codebase, API documentation, or best practices. |
| 31 | +- 🔄 **Automate Repetitive Tasks** – Reduce tedious manual work with smart automation. |
| 32 | +- 🏗 **Create New Files & Projects** – Kickstart your next big idea in seconds. |
56 | 33 |
|
57 | | -MCP extends Seawolf capabilities by allowing you to add unlimited custom tools. Integrate with external APIs, connect to databases, or create specialized development tools - MCP provides the framework to expand Seawolf functionality to meet your specific needs. |
| 34 | +--- |
58 | 35 |
|
59 | | -### Customization |
| 36 | +## ⚡ Quick Start |
60 | 37 |
|
61 | | -Make Seawolf work your way with: |
| 38 | +Getting started with Seawolf is as easy as 1-2-3: |
62 | 39 |
|
63 | | -- Custom Instructions for personalized behavior |
64 | | -- Custom Modes for specialized tasks |
65 | | -- Local Models for offline use |
66 | | -- Auto-Approval Settings for faster workflows |
| 40 | +1️⃣ **Install Seawolf** from the **VS Code Marketplace** |
| 41 | +2️⃣ **Connect your preferred AI provider** (OpenAI, local models, or custom API) |
| 42 | +3️⃣ **Start your first task** – Just type your request and let Seawolf do the magic! 🪄 |
67 | 43 |
|
68 | 44 | --- |
69 | 45 |
|
70 | | -## Local Setup & Development |
71 | | - |
72 | | -1. **Clone** the repo: |
73 | | - |
74 | | - git clone https://github.com/Opensourceful/Seawolf.git |
| 46 | +## 🔑 Key Features |
75 | 47 |
|
76 | | -2. **Install dependencies**: |
| 48 | +### 🎭 Multiple Modes |
77 | 49 |
|
78 | | - npm run install:all |
| 50 | +Seawolf adapts to your workflow with specialized modes: |
79 | 51 |
|
80 | | -3. **Start the webview (Vite/React app with HMR)**: |
| 52 | +- 🏗 **Code Mode** – Write, edit, and optimize code. |
| 53 | +- 🎯 **Architect Mode** – Plan and analyze software designs. |
| 54 | +- 🤖 **Ask Mode** – Answer coding questions and provide explanations. |
| 55 | +- 🐞 **Debug Mode** – Troubleshoot errors and suggest fixes. |
| 56 | +- 🛠 **Custom Modes** – Define unlimited specialized personas for security audits, performance tuning, or documentation. |
81 | 57 |
|
82 | | - npm run dev |
| 58 | +### 🛠 Smart Tools |
83 | 59 |
|
84 | | -4. **Debug**: |
85 | | - Press F5 (or **Run > Start Debugging**) in VSCode to open a new session with Seawolf loaded. |
| 60 | +Seawolf is **more than just an AI chatbot**—it comes equipped with powerful automation tools: |
86 | 61 |
|
87 | | -Changes to the webview will appear immediately. Changes to the core extension will require a restart of the extension host. |
| 62 | +- 📂 **Read & modify files** in your project workspace. |
| 63 | +- 🔄 **Execute terminal commands** inside VS Code. |
| 64 | +- 🌍 **Control a web browser** for automation tasks. |
| 65 | +- 🔌 **Use external tools via MCP (Model Context Protocol)** to integrate APIs, databases, or custom development tools. |
88 | 66 |
|
89 | | -Alternatively you can build a .vsix and install it directly in VSCode: |
| 67 | +> 🔗 **MCP allows Seawolf to grow with you!** Extend its capabilities by integrating third-party APIs, database queries, and more. |
90 | 68 |
|
91 | | - npm run build |
| 69 | +### 🎨 Customization |
92 | 70 |
|
93 | | -A .vsix file will appear in the bin/ directory which can be installed with: |
| 71 | +Make Seawolf work **your way** with: |
94 | 72 |
|
95 | | - code --install-extension bin/Seawolf-<version>.vsix |
96 | | - |
97 | | -We use [changesets](https://github.com/changesets/changesets) for versioning and publishing. Check our CHANGELOG.md for release notes. |
| 73 | +- 📝 **Custom Instructions** – Tailor responses to match your workflow. |
| 74 | +- 🎭 **Custom Modes** – Create AI agents for specific roles. |
| 75 | +- 🏠 **Local Models** – Run AI offline for privacy and security. |
| 76 | +- ✅ **Auto-Approval Settings** – Speed up repetitive workflows. |
98 | 77 |
|
99 | 78 | --- |
100 | | - |
101 | | -## License |
102 | | - |
103 | | -[Apache 2.0](./LICENSE) |
0 commit comments