Skip to content

Commit 34f624f

Browse files
docs: updated README
1 parent dddc7b9 commit 34f624f

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,28 @@ go build -o createos .
2626

2727
**1. Sign in**
2828

29-
Get your API token from your [CreateOS dashboard](https://createos.nodeops.network/profile), then run:
29+
Choose one of the following methods:
30+
31+
**Option A — Browser login (OAuth, recommended)**
3032

3133
```bash
3234
createos login
3335
```
3436

37+
This opens your browser to complete sign in. Your session is saved automatically.
38+
39+
**Option B — API token**
40+
41+
Get your API token from your [CreateOS dashboard](https://createos.nodeops.network/profile), then run:
42+
43+
```bash
44+
createos login --token <your-api-token>
45+
```
46+
47+
Or run `createos login` interactively and select "Sign in with API token" when prompted.
48+
49+
> In CI or non-interactive environments, you must use the `--token` flag.
50+
3551
**2. Confirm your account**
3652

3753
```bash
@@ -77,8 +93,8 @@ createos --help
7793

7894
| Command | Description |
7995
| -------------------------------- | --------------------------------- |
80-
| `createos environments list` | List environment variables |
81-
| `createos environments delete` | Delete an environment variable |
96+
| `createos environments list` | List environments for a project |
97+
| `createos environments delete` | Delete an environment |
8298

8399
### Domains
84100

@@ -140,9 +156,6 @@ createos --help
140156
## Security
141157

142158
- Your API token is stored at `~/.createos/.token` with `600` permissions (readable only by you).
159+
- OAuth session tokens are stored at `~/.createos/.oauth` with `600` permissions (readable only by you).
143160
- Debug mode masks your token in output — only the first 6 and last 4 characters are shown.
144161
- Never share your token or commit it to version control.
145-
146-
## License
147-
148-
MIT

0 commit comments

Comments
 (0)