crewx-bridge 0.2.35 → 0.2.36
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 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,23 +31,67 @@ full-access agents.
|
|
|
31
31
|
- Node.js 22.13 or later
|
|
32
32
|
- macOS or Linux
|
|
33
33
|
- the coding runtimes you intend to use already authenticated for the OS user
|
|
34
|
-
- a one-time enrollment
|
|
34
|
+
- a CrewX account, or a one-time enrollment code if an administrator is
|
|
35
|
+
connecting this machine on your behalf
|
|
35
36
|
|
|
36
37
|
Do not install or run Bridge as root. On a shared or production host, use a
|
|
37
38
|
dedicated OS user.
|
|
38
39
|
|
|
39
|
-
## Install
|
|
40
|
+
## Install
|
|
40
41
|
|
|
41
|
-
|
|
42
|
+
One command signs you in, connects this machine, and creates your first agent.
|
|
43
|
+
It installs the per-user service too, so the machine keeps answering after you
|
|
44
|
+
close the terminal.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
npx crewx-bridge@latest install
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
It will ask you to approve the sign-in in a browser, pick a workspace if you
|
|
51
|
+
belong to more than one, and choose the folder the agent may work in.
|
|
52
|
+
|
|
53
|
+
To pin it to a self-hosted CrewX, or to name the machine yourself:
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
npx crewx-bridge@latest install \
|
|
57
|
+
--url https://crewx.example \
|
|
58
|
+
--name "Build Mac" \
|
|
59
|
+
--workspace acme
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Prefer a global install for a long-lived machine — `npx` runs out of a cache
|
|
63
|
+
npm may prune, and a service installed from it stops working the day that
|
|
64
|
+
happens:
|
|
42
65
|
|
|
43
66
|
```sh
|
|
44
67
|
npm install --global crewx-bridge
|
|
68
|
+
crewx-bridge install
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Signing in separately
|
|
72
|
+
|
|
73
|
+
`install` does this for you. These exist for re-authenticating a machine that
|
|
74
|
+
is already connected:
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
crewx-bridge login
|
|
78
|
+
crewx-bridge logout
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Enrolling with a one-time code
|
|
82
|
+
|
|
83
|
+
For a machine an administrator provisions on someone else's behalf, where
|
|
84
|
+
signing in as yourself is not what you want:
|
|
85
|
+
|
|
86
|
+
```sh
|
|
45
87
|
crewx-bridge enroll \
|
|
46
88
|
--url https://crewx.example \
|
|
47
89
|
--code crwb_enroll_… \
|
|
48
90
|
--name "Build Mac"
|
|
49
91
|
```
|
|
50
92
|
|
|
93
|
+
## Approving folders
|
|
94
|
+
|
|
51
95
|
Register each project locally. The CrewX web application sees only the name,
|
|
52
96
|
opaque ID, and filesystem identity—not the path.
|
|
53
97
|
|