EntryGuard CLI (eg)
The EntryGuard CLI lets you start, stop, and manage IP whitelisting sessions directly from your terminal — no browser required.
Why Use the CLI?
- Speed — Start a session in one command:
eg session start - Automation — Script session management in CI/CD pipelines and shell scripts
- Multiple organizations — Switch between profiles like the AWS CLI (
--profile) - JSON output — Pipe structured data to
jqor other tools with--output json
Quick Example
# Start a session (auto-detects your IP)
eg session start
# Check your status
eg status
# Stop your active session
eg session stop
Prerequisites
- An EntryGuard account with resources assigned to your user
- An API key for authentication — see Create & Manage API Keys
Commands
| Command | Description |
|---|---|
eg profile add <name> | Add a new profile with API key |
eg profile list | List configured profiles |
eg profile use <name> | Set default profile |
eg profile remove <name> | Remove a profile |
eg session start | Start a new session |
eg session stop [id] | Stop a session |
eg session list | List your sessions |
eg session get <id> | Get session details |
eg session extend <id> | Extend a session |
eg ip | Detect your public IP |
eg status | Combined overview |
Global Flags
| Flag | Description | Default |
|---|---|---|
--profile <name> | Use a specific profile instead of the default | Default profile |
--output <format> | Output format: table or json | table |
Next Steps
API Reference: The CLI uses the same API as the web dashboard. See API Overview.