@untools/devflow 0.2.7 → 0.2.9
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.
- package/README.md +28 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,25 @@
|
|
|
1
|
-
# @untools/devflow
|
|
1
|
+
# @untools/devflow - Copilot-Powered DevOps Agent
|
|
2
2
|
|
|
3
|
-
The self-hosted CLI agent for **DevFlow** -
|
|
3
|
+
The self-hosted CLI agent for **DevFlow** - powered by the **GitHub Copilot CLI** and **GitHub Copilot SDK**.
|
|
4
4
|
|
|
5
|
-
Install this CLI tool on your local machine or server to execute AI-driven development tasks securely on your own infrastructure.
|
|
5
|
+
Install this CLI tool on your local machine or server to execute AI-driven development tasks securely on your own infrastructure, leveraging the full power of GitHub Copilot.
|
|
6
6
|
|
|
7
7
|
## What is DevFlow?
|
|
8
8
|
|
|
9
|
-
DevFlow is a
|
|
9
|
+
DevFlow is a platform that orchestrates AI-powered development workflows. Create a DevFlow account, connect your GitHub repositories and communication channels (Slack, Telegram), then use the **@untools/devflow** CLI to execute complex development tasks right from your machine.
|
|
10
|
+
|
|
11
|
+
It acts as a bridge between your infrastructure and the AI, utilizing:
|
|
12
|
+
|
|
13
|
+
- [GitHub Copilot CLI](https://github.com/features/copilot/cli) for intelligent command understanding.
|
|
14
|
+
- [GitHub Copilot SDK](https://github.com/github/copilot-sdk) for agentic workflows.
|
|
10
15
|
|
|
11
16
|
**Key Features:**
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
17
|
+
|
|
18
|
+
- 🤖 **Copilot-Powered Workflows**: Fix bugs, implement features, and explain code using GitHub Copilot's intelligence.
|
|
19
|
+
- 🔒 **Self-hosted & Secure**: Code never leaves your machine. Secure tunneling for remote control.
|
|
20
|
+
- 📱 **ChatOps**: Control your dev environment from Slack or Telegram.
|
|
21
|
+
- 🔗 **GitHub Integration**: Deep integration with repositories, issues, and PRs.
|
|
22
|
+
- ⚡ **Real-time Tasks**: Execute long-running tasks with live progress updates.
|
|
18
23
|
|
|
19
24
|
## Installation
|
|
20
25
|
|
|
@@ -41,6 +46,7 @@ devflow init
|
|
|
41
46
|
```
|
|
42
47
|
|
|
43
48
|
This command will:
|
|
49
|
+
|
|
44
50
|
- Prompt you for your DevFlow account credentials
|
|
45
51
|
- Open a browser for OAuth authentication if needed
|
|
46
52
|
- Save a secure JWT token to `~/.devflow/config.json`
|
|
@@ -55,6 +61,7 @@ devflow start
|
|
|
55
61
|
```
|
|
56
62
|
|
|
57
63
|
The agent will:
|
|
64
|
+
|
|
58
65
|
- Connect to the DevFlow platform
|
|
59
66
|
- Poll for pending tasks every 5 seconds
|
|
60
67
|
- Execute workflows using GitHub Copilot
|
|
@@ -64,6 +71,7 @@ The agent will:
|
|
|
64
71
|
### 3. Execute Tasks
|
|
65
72
|
|
|
66
73
|
Tasks are created through the DevFlow web dashboard or API. Once you start the agent, it will automatically:
|
|
74
|
+
|
|
67
75
|
1. Receive task assignments
|
|
68
76
|
2. Execute workflows (fix-bug, feature, explain, review-pr)
|
|
69
77
|
3. Update task progress in real-time
|
|
@@ -132,7 +140,7 @@ Initialize and authenticate with the DevFlow platform.
|
|
|
132
140
|
```bash
|
|
133
141
|
devflow init
|
|
134
142
|
# ? Platform URL: https://devflow.dev
|
|
135
|
-
# ? Authenticate with DevFlow? (Y/n)
|
|
143
|
+
# ? Authenticate with DevFlow? (Y/n)
|
|
136
144
|
# ✓ Configuration saved to ~/.devflow/config.json
|
|
137
145
|
```
|
|
138
146
|
|
|
@@ -149,6 +157,7 @@ devflow start
|
|
|
149
157
|
```
|
|
150
158
|
|
|
151
159
|
The agent will display:
|
|
160
|
+
|
|
152
161
|
- Incoming task assignments
|
|
153
162
|
- Execution progress
|
|
154
163
|
- Completion status
|
|
@@ -180,12 +189,12 @@ devflow help
|
|
|
180
189
|
|
|
181
190
|
The agent can execute these AI-powered workflows:
|
|
182
191
|
|
|
183
|
-
| Workflow
|
|
184
|
-
|
|
185
|
-
| `fix-bug`
|
|
186
|
-
| `feature`
|
|
187
|
-
| `explain`
|
|
188
|
-
| `review-pr` | Review pull request for best practices
|
|
192
|
+
| Workflow | Description | Input |
|
|
193
|
+
| ----------- | -------------------------------------------------- | -------------------------------- |
|
|
194
|
+
| `fix-bug` | Analyze issue, fix code, run tests, create PR | Issue description, repo URL |
|
|
195
|
+
| `feature` | Implement new feature with tests and documentation | Feature requirements, repo URL |
|
|
196
|
+
| `explain` | Generate documentation for code | Code snippet, documentation type |
|
|
197
|
+
| `review-pr` | Review pull request for best practices | PR URL, focus areas |
|
|
189
198
|
|
|
190
199
|
## Task Execution Flow
|
|
191
200
|
|
|
@@ -299,6 +308,7 @@ The DevFlow system consists of three components:
|
|
|
299
308
|
3. **Agent-Host** - Local service that runs Copilot SDK workflows
|
|
300
309
|
|
|
301
310
|
Communication flow:
|
|
311
|
+
|
|
302
312
|
```
|
|
303
313
|
Web Platform → Agent CLI (polls) → Agent-Host (executes)
|
|
304
314
|
↓
|
|
@@ -342,4 +352,4 @@ MIT License - see LICENSE file for details
|
|
|
342
352
|
|
|
343
353
|
**Made with ❤️ for developers by the DevFlow team**
|
|
344
354
|
|
|
345
|
-
Built
|
|
355
|
+
Built with GitHub Copilot CLI for the [GitHub Copilot CLI Challenge](https://dev.to/devteam/join-the-github-copilot-cli-challenge-win-github-universe-tickets-copilot-pro-subscriptions-and-50af?bb=260467)
|