forkoff 1.0.0 → 1.0.2
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 +10 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="
|
|
2
|
+
<img src="https://www.forkoff.app/images/logo.png" alt="ForkOff Logo" width="200"/>
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">ForkOff CLI</h1>
|
|
@@ -22,23 +22,16 @@
|
|
|
22
22
|
|
|
23
23
|
ForkOff CLI connects your development machine to the ForkOff mobile app, enabling you to:
|
|
24
24
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
25
|
+
- **Control AI coding sessions** from your phone
|
|
26
|
+
- **Approve code changes** on the go
|
|
27
|
+
- **Send prompts** to Claude, Cursor, and other AI tools
|
|
28
|
+
- **Monitor progress** in real-time
|
|
29
|
+
- **Get notifications** for permission requests
|
|
30
30
|
|
|
31
31
|
## Installation
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
|
|
35
|
-
npm install -g forkoff-cli
|
|
36
|
-
|
|
37
|
-
# Or clone and link for development
|
|
38
|
-
git clone https://github.com/Forkoff-app/forkoff-cli.git
|
|
39
|
-
cd forkoff-cli
|
|
40
|
-
npm install
|
|
41
|
-
npm link
|
|
34
|
+
npm install -g forkoff
|
|
42
35
|
```
|
|
43
36
|
|
|
44
37
|
## Quick Start
|
|
@@ -97,7 +90,7 @@ forkoff config --reset
|
|
|
97
90
|
Integrate ForkOff into your AI coding tools:
|
|
98
91
|
|
|
99
92
|
```typescript
|
|
100
|
-
import { createIntegration } from 'forkoff
|
|
93
|
+
import { createIntegration } from 'forkoff';
|
|
101
94
|
|
|
102
95
|
const forkoff = createIntegration();
|
|
103
96
|
|
|
@@ -133,7 +126,7 @@ if (approval.status === 'approved') {
|
|
|
133
126
|
}
|
|
134
127
|
|
|
135
128
|
// Send terminal output
|
|
136
|
-
forkoff.sendTerminalOutput(sessionId, '> npm install\n
|
|
129
|
+
forkoff.sendTerminalOutput(sessionId, '> npm install\n Done', 'stdout');
|
|
137
130
|
forkoff.sendTerminalExit(sessionId, 0);
|
|
138
131
|
|
|
139
132
|
// Update device status
|
|
@@ -157,14 +150,7 @@ Configuration files are stored at:
|
|
|
157
150
|
## Requirements
|
|
158
151
|
|
|
159
152
|
- Node.js 18+
|
|
160
|
-
- ForkOff mobile app
|
|
161
|
-
|
|
162
|
-
---
|
|
163
|
-
|
|
164
|
-
## Related Projects
|
|
165
|
-
|
|
166
|
-
- [ForkOff Mobile App](https://github.com/Forkoff-app/forkoff-react-native) - React Native mobile app
|
|
167
|
-
- [ForkOff Backend](https://github.com/Forkoff-app/forkoff-backend) - API server
|
|
153
|
+
- ForkOff mobile app
|
|
168
154
|
|
|
169
155
|
---
|
|
170
156
|
|