Skip to content

Commit 988902b

Browse files
authored
Refine setup instructions in README
Updated the README to clarify admin and developer setup steps, including numbering the instructions for better readability.
1 parent 13ab80e commit 988902b

1 file changed

Lines changed: 23 additions & 14 deletions

File tree

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -261,41 +261,50 @@ For production, put the server behind a reverse proxy like nginx with HTTPS enab
261261

262262
### Team workflow
263263

264-
**Admin (one time):**
264+
**Admin (one time setup):**
265265

266266
```bash
267-
# Start the server
267+
# 1. Start the server
268268
ENVEIL_API_KEY=shared-api-key ENVEIL_VAULT_PASSWORD=vault-pass ENVEIL_PORT=8080 enveil-server
269269

270-
# Connect your own CLI to it
271-
enveil server connect http://your-server:8080 --key shared-api-key
272-
273-
# Register your project on the server
270+
# 2. Register and import the project locally BEFORE connecting to the server
274271
cd ~/projects/myapp
275272
enveil init
276-
277-
# Import your existing secrets
278273
enveil import .env
274+
275+
# 3. Connect to the server
276+
enveil server connect http://your-server:8080 --key shared-api-key
277+
278+
# 4. Push the local project to the server
279+
enveil server push
279280
```
280281

281-
**Each developer (one time):**
282+
`server push` creates the project on the server if it does not exist, then uploads all environments and variables encrypted. From this point the server is the source of truth for the team.
283+
284+
**Each developer (one time setup):**
282285

283286
```bash
284-
# Connect to the server
287+
# 1. Connect to the server
285288
enveil server connect http://your-server:8080 --key shared-api-key
286289

287-
# Associate their local directory with the shared project
290+
# 2. Associate the local directory with the project on the server
288291
cd ~/projects/myapp
289292
enveil server use-project myapp
293+
294+
# 3. Run the app — no .env file needed
295+
enveil run npm run dev
290296
```
291297

292298
From that point, all `set`, `get`, `list`, `run`, `import`, `export`, `diff`, and `env` commands operate against the shared server. Variables set by one developer are immediately available to all others. No `.env` files are shared, committed, or sent over chat.
293299

294-
**Checking server status:**
300+
**Server commands reference:**
295301

296302
```bash
297-
enveil server status # verify connection
298-
enveil server disconnect # switch back to local vault
303+
enveil server connect http://your-server:8080 --key shared-api-key # connect to server
304+
enveil server push # push local project to server
305+
enveil server use-project # associate directory with server project
306+
enveil server status # verify connection
307+
enveil server disconnect # switch back to local vault
299308
```
300309

301310
## Project structure

0 commit comments

Comments
 (0)