Skip to content

Commit b65f3a5

Browse files
CopilotMossaka
andcommitted
docs: address review feedback on CLI reference
Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/3205fc6a-2852-4cee-bc87-7ada09a9761e Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
1 parent bc00c90 commit b65f3a5

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs-site/src/content/docs/reference/cli-reference.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,13 @@ rules:
127127
**Fields:**
128128
- `version` — Must be `1`
129129
- `rules` — Array of rule objects
130-
- `domain` *(required)* — Domain name to allow
131-
- `subdomains` *(optional, default: `true`)* — Whether to also allow all subdomains
130+
131+
Each rule has the following fields:
132+
133+
| Field | Required | Default | Description |
134+
|-------|----------|---------|-------------|
135+
| `domain` | Yes | — | Domain name to allow |
136+
| `subdomains` | No | `true` | Whether to also allow all subdomains |
132137

133138
### `--block-domains <domains>`
134139

@@ -323,7 +328,7 @@ DB_HOST=localhost
323328
DB_PORT=5432
324329
325330
# API settings
326-
API_KEY=my-key
331+
API_KEY=your-api-key-here
327332
DEBUG=true
328333
```
329334

0 commit comments

Comments
 (0)