newo 1.2.1 → 1.2.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 +47 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,21 +3,62 @@
|
|
|
3
3
|
Mirror NEWO "Project → Agent → Flow → Skills" to local files and back, Git-first.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
|
+
|
|
7
|
+
### Option 1: Global Installation (Recommended)
|
|
8
|
+
```bash
|
|
9
|
+
npm install -g newo
|
|
10
|
+
```
|
|
11
|
+
After global installation, use the CLI anywhere:
|
|
12
|
+
```bash
|
|
13
|
+
newo pull
|
|
14
|
+
newo push
|
|
15
|
+
newo status
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Option 2: Local Installation
|
|
19
|
+
```bash
|
|
20
|
+
# In your project directory
|
|
21
|
+
npm install newo
|
|
22
|
+
```
|
|
23
|
+
Use with npx:
|
|
6
24
|
```bash
|
|
25
|
+
npx newo pull
|
|
26
|
+
npx newo push
|
|
27
|
+
npx newo status
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Option 3: Development Installation
|
|
31
|
+
```bash
|
|
32
|
+
# Clone the repository
|
|
33
|
+
git clone https://github.com/sabbah13/newo-cli.git
|
|
34
|
+
cd newo-cli
|
|
7
35
|
npm install
|
|
8
36
|
```
|
|
9
37
|
|
|
10
38
|
## Configure
|
|
39
|
+
|
|
40
|
+
### Step 1: Get Your NEWO API Key
|
|
41
|
+
1. **Login** to your [app.newo.ai](https://app.newo.ai) account
|
|
42
|
+
2. **Navigate** to the **Integrations** page
|
|
43
|
+
3. **Find** the **API Integration** in the list
|
|
44
|
+
4. **Create** a new **Connector** for this Integration
|
|
45
|
+
5. **Copy** your API key (it will look like: `458663bd41f2d1...`)
|
|
46
|
+
|
|
47
|
+
### Step 2: Setup Environment
|
|
11
48
|
```bash
|
|
12
49
|
cp .env.example .env
|
|
13
50
|
# Edit .env with your values
|
|
14
51
|
```
|
|
15
|
-
|
|
52
|
+
|
|
53
|
+
Required environment variables:
|
|
16
54
|
- `NEWO_BASE_URL` (default `https://app.newo.ai`)
|
|
17
|
-
- `NEWO_PROJECT_ID`
|
|
18
|
-
-
|
|
19
|
-
|
|
20
|
-
|
|
55
|
+
- `NEWO_PROJECT_ID` (your project UUID from NEWO)
|
|
56
|
+
- `NEWO_API_KEY` (your API key from Step 1)
|
|
57
|
+
|
|
58
|
+
Optional (advanced):
|
|
59
|
+
- `NEWO_ACCESS_TOKEN` (direct access token)
|
|
60
|
+
- `NEWO_REFRESH_TOKEN` (refresh token)
|
|
61
|
+
- `NEWO_REFRESH_URL` (custom refresh endpoint)
|
|
21
62
|
|
|
22
63
|
## Commands
|
|
23
64
|
```bash
|
|
@@ -63,7 +104,7 @@ jobs:
|
|
|
63
104
|
- run: node ./src/cli.js push
|
|
64
105
|
env:
|
|
65
106
|
NEWO_BASE_URL: https://app.newo.ai
|
|
66
|
-
NEWO_PROJECT_ID:
|
|
107
|
+
NEWO_PROJECT_ID: ${{ secrets.NEWO_PROJECT_ID }}
|
|
67
108
|
NEWO_API_KEY: ${{ secrets.NEWO_API_KEY }}
|
|
68
109
|
# Optional:
|
|
69
110
|
# NEWO_REFRESH_URL: ${{ secrets.NEWO_REFRESH_URL }}
|