Skip to content

Commit 1e6e9d6

Browse files
rgarciacursoragent
andauthored
Add kernel proxies docs to readme (#35)
This pull request contains changes generated by a Cursor Cloud Agent <a href="https://cursor.com/background-agent?bcId=bc-47e20e71-6de7-49e7-a9dd-cfe88fce4fad"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-cursor-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-cursor-light.svg"><img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg"></picture></a>&nbsp;<a href="https://cursor.com/agents?id=bc-47e20e71-6de7-49e7-a9dd-cfe88fce4fad"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-web-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-web-light.svg"><img alt="Open in Web" src="https://cursor.com/open-in-web.svg"></picture></a> Co-authored-by: Cursor Agent <[email protected]>
1 parent f66cb26 commit 1e6e9d6

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,30 @@ Create an API key from the [Kernel dashboard](https://dashboard.onkernel.com).
304304
- `kernel extensions delete <id-or-name>` - Delete an extension by ID or name
305305
- `-y, --yes` - Skip confirmation prompt
306306

307+
### Proxy Management
308+
309+
- `kernel proxies list` - List proxy configurations
310+
- `kernel proxies get <id>` - Get a proxy configuration by ID
311+
- `kernel proxies create` - Create a new proxy configuration
312+
313+
- `--name <name>` - Proxy configuration name
314+
- `--type <type>` - Proxy type: datacenter, isp, residential, mobile, custom (required)
315+
- `--protocol <http|https>` - Protocol to use (default: https)
316+
- `--country <code>` - ISO 3166 country code or "EU" (location-based types)
317+
- `--city <name>` - City name (no spaces, e.g. sanfrancisco) (residential, mobile; requires `--country`)
318+
- `--state <code>` - Two-letter state code (residential, mobile)
319+
- `--zip <zip>` - US ZIP code (residential, mobile)
320+
- `--asn <asn>` - Autonomous system number (e.g., AS15169) (residential, mobile)
321+
- `--os <os>` - Operating system: windows, macos, android (residential)
322+
- `--carrier <carrier>` - Mobile carrier (mobile)
323+
- `--host <host>` - Proxy host (custom; required)
324+
- `--port <port>` - Proxy port (custom; required)
325+
- `--username <username>` - Username for proxy authentication (custom)
326+
- `--password <password>` - Password for proxy authentication (custom)
327+
328+
- `kernel proxies delete <id>` - Delete a proxy configuration
329+
- `-y, --yes` - Skip confirmation prompt
330+
307331
## Examples
308332

309333
### Deploy with environment variables
@@ -456,6 +480,34 @@ kernel extensions delete my-extension-name --yes
456480
kernel browsers extensions upload my-browser ./extension1 ./extension2
457481
```
458482

483+
### Proxy management
484+
485+
```bash
486+
# List proxy configurations
487+
kernel proxies list
488+
489+
# Create a datacenter proxy
490+
kernel proxies create --type datacenter --country US --name "US Datacenter"
491+
492+
# Create a datacenter proxy using HTTP protocol
493+
kernel proxies create --type datacenter --country US --protocol http --name "US DC (HTTP)"
494+
495+
# Create a custom proxy
496+
kernel proxies create --type custom --host proxy.example.com --port 8080 --username myuser --password mypass --name "My Custom Proxy"
497+
498+
# Create a residential proxy with location and OS
499+
kernel proxies create --type residential --country US --city sanfrancisco --state CA --zip 94107 --asn AS15169 --os windows --name "SF Residential"
500+
501+
# Create a mobile proxy with carrier
502+
kernel proxies create --type mobile --country US --carrier verizon --name "US Mobile"
503+
504+
# Get proxy details
505+
kernel proxies get prx_123
506+
507+
# Delete a proxy (skip confirmation)
508+
kernel proxies delete prx_123 --yes
509+
```
510+
459511
## Getting Help
460512

461513
- `kernel --help` - Show all available commands

0 commit comments

Comments
 (0)