Skip to content

Commit 341b2a9

Browse files
tembo[bot]tembo[bot]
committed
Add documentation for new proxies CLI feature
- Add comprehensive CLI documentation for the new proxies commands under kernel beta proxies - Include detailed command reference for create, list, get, and delete operations - Document all proxy types (datacenter, isp, residential, mobile, custom) with their specific configuration options - Add examples for common use cases and proxy configurations - Update main CLI documentation to include proxies section - Update navigation in docs.json to include the new proxies CLI reference
1 parent 61bcebe commit 341b2a9

File tree

3 files changed

+122
-1
lines changed

3 files changed

+122
-1
lines changed

‎docs.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@
134134
"reference/cli",
135135
"reference/cli/auth",
136136
"reference/cli/browsers",
137-
"reference/cli/apps"
137+
"reference/cli/apps",
138+
"reference/cli/proxies"
138139
]
139140
}
140141
]

‎reference/cli.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ kernel --version
3434
<Card icon="rocket" title="Apps" href="/reference/cli/apps">
3535
Deploy apps, invoke actions, and stream logs.
3636
</Card>
37+
<Card icon="network" title="Proxies (Beta)" href="/reference/cli/proxies">
38+
Manage proxy configurations for enhanced browser sessions.
39+
</Card>
3740
</Columns>
3841

3942
## Quick Start

‎reference/cli/proxies.mdx‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
title: "Proxies"
3+
---
4+
5+
Manage proxy configurations for enhanced browser sessions. Proxy configurations help avoid bot detection by routing browser traffic through different IP addresses and locations.
6+
7+
<Warning>
8+
This feature is currently in beta and available under the `kernel beta proxies` command.
9+
</Warning>
10+
11+
## Overview
12+
13+
### `kernel beta proxies list`
14+
List all proxy configurations.
15+
16+
### `kernel beta proxies get <id>`
17+
Get detailed information about a specific proxy configuration.
18+
19+
| Argument | Description |
20+
|----------|-------------|
21+
| `<id>` | Proxy configuration ID. Required. |
22+
23+
### `kernel beta proxies create`
24+
Create a new proxy configuration.
25+
26+
| Flag | Description |
27+
|------|-------------|
28+
| `--type <type>` | Proxy type: `datacenter`, `isp`, `residential`, `mobile`, or `custom`. Required. |
29+
| `--name <name>` | Proxy configuration name. Optional. |
30+
31+
#### Location Flags (for datacenter, isp, residential, mobile types)
32+
33+
| Flag | Description |
34+
|------|-------------|
35+
| `--country <code>` | ISO 3166 country code or EU. Required for `datacenter` and `isp` types. |
36+
| `--city <name>` | City name (no spaces, e.g., `sanfrancisco`). Optional. |
37+
| `--state <code>` | Two-letter state code. Optional. |
38+
| `--zip <code>` | US ZIP code. Optional. |
39+
| `--asn <number>` | Autonomous system number (e.g., `AS15169`). Optional. |
40+
41+
#### Additional Flags
42+
43+
| Flag | Description |
44+
|------|-------------|
45+
| `--os <system>` | Operating system for residential proxies: `windows`, `macos`, or `android`. Optional. |
46+
| `--carrier <name>` | Mobile carrier for mobile proxies. Optional. |
47+
48+
#### Custom Proxy Flags
49+
50+
| Flag | Description |
51+
|------|-------------|
52+
| `--host <address>` | Proxy host address or IP. Required for `custom` type. |
53+
| `--port <number>` | Proxy port. Required for `custom` type. |
54+
| `--username <user>` | Username for proxy authentication. Optional. |
55+
| `--password <pass>` | Password for proxy authentication. Optional. |
56+
57+
### `kernel beta proxies delete <id>`
58+
Delete a proxy configuration.
59+
60+
| Argument | Description |
61+
|----------|-------------|
62+
| `<id>` | Proxy configuration ID. Required. |
63+
64+
| Flag | Description |
65+
|------|-------------|
66+
| `--yes`, `-y` | Skip confirmation prompt. Optional. |
67+
68+
## Proxy Types
69+
70+
Proxy types are ranked from best to worst for bot detection avoidance:
71+
72+
1. **mobile** - Mobile carrier proxies (highest anonymity)
73+
2. **residential** - Residential IP proxies
74+
3. **isp** - ISP proxies
75+
4. **datacenter** - Datacenter proxies
76+
5. **custom** - Your own proxy server (depends on your setup)
77+
78+
## Examples
79+
80+
### Create a datacenter proxy
81+
```bash
82+
kernel beta proxies create --type datacenter --country US --name "US Datacenter"
83+
```
84+
85+
### Create a residential proxy with location
86+
```bash
87+
kernel beta proxies create --type residential --country US --city sanfrancisco --state CA
88+
```
89+
90+
### Create a mobile proxy
91+
```bash
92+
kernel beta proxies create --type mobile --country US --carrier verizon
93+
```
94+
95+
### Create a custom proxy
96+
```bash
97+
kernel beta proxies create --type custom --host proxy.example.com --port 8080 --username myuser --password mypass
98+
```
99+
100+
### List all proxies
101+
```bash
102+
kernel beta proxies list
103+
```
104+
105+
### Get proxy details
106+
```bash
107+
kernel beta proxies get proxy_123abc
108+
```
109+
110+
### Delete a proxy
111+
```bash
112+
kernel beta proxies delete proxy_123abc --yes
113+
```
114+
115+
## Using Proxies with Browsers
116+
117+
Once you've created a proxy configuration, you can use it with browser sessions through the API. See the [API Reference](/api-reference/proxies/create-proxy) for details on integrating proxies with browser creation.

0 commit comments

Comments
 (0)