Skip to content

Commit 2f6cda4

Browse files
authored
Merge pull request #136 from epilot-dev/docs/cli-readonly-flag
docs(cli): document read-only login (--readonly)
2 parents 0d1ec05 + 782da8a commit 2f6cda4

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

‎docs/cli/overview.md‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ Run `epilot <api>` to list available operations. Run `epilot <api> <operationId>
9898
# Browser-based login (opens epilot portal)
9999
epilot auth login
100100

101+
# Browser-based login restricted to a read-only session
102+
epilot auth login --readonly
103+
101104
# Manual token
102105
epilot auth login --token <your-token>
103106

@@ -107,7 +110,7 @@ epilot entity listSchemas --token <your-token>
107110
# Or via environment variable
108111
EPILOT_TOKEN=<your-token> epilot entity listSchemas
109112

110-
# Check auth status
113+
# Check auth status (shows whether the token is read-only)
111114
epilot auth status
112115

113116
# Logout
@@ -121,6 +124,28 @@ Token resolution order:
121124
4. Stored credentials (`~/.config/epilot/credentials.json`)
122125
5. Interactive prompt (if TTY)
123126

127+
### Read-only sessions
128+
129+
Pass `--readonly` to `epilot auth login` to obtain a read-only token. A read-only session can perform read actions (view, export, download) but is denied any write action, regardless of the roles your account holds.
130+
131+
```bash
132+
epilot auth login --readonly
133+
```
134+
135+
When you run this, the browser authorize page pre-checks and locks the **Read-only mode** option, so the resulting CLI session is always read-only. You can also opt into read-only mode manually from that page during a normal `epilot auth login` (the checkbox is left unchecked by default).
136+
137+
`epilot auth status` reports the current token's access level on the `Access` line:
138+
139+
```
140+
Access: read-only
141+
```
142+
143+
vs. a normal read-write token:
144+
145+
```
146+
Access: read-write
147+
```
148+
124149
## Parameters
125150

126151
```bash

0 commit comments

Comments
 (0)