Lens

https://docs.lenshq.io/
Admin
Lens is a Kubernetes platform and IDE that enables developers and operations teams to manage,...
Tokens:301,394
Snippets:2,903
Trust Score:7.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /v1/installation

Source: https://docs.lenshq.io/lens-agents/reference/api

Returns installation information. This endpoint requires no authentication because it runs before an install has any identities.

```APIDOC
## GET /v1/installation

### Description
Returns installation information. This endpoint requires no authentication because it runs before an install has any identities.

### Method
GET

### Endpoint
/v1/installation

### Authentication
None

### Response
#### Success Response (200)
Returns installation details.

#### Response Example
(Not provided in source)
```

--------------------------------

### Silent installation for all users

Source: https://docs.lenshq.io/k8slens/getting-started/install-lens

Run the installer with the /S and /allusers flags to install for all users. This requires administrator privileges.

```bash
Lens.Setup.<RELEASE-ID>.exe /S /allusers
```

--------------------------------

### Install Prism Agent with one-line installer

Source: https://docs.lenshq.io/prism-agent/installation/native

One-line installer for macOS/Linux (install.sh) and Windows PowerShell (install.ps1). Installs the prism and prism-server binaries and registers prism-server as a background service. On Windows no admin elevation is needed; on Windows arm64 it installs the x64 build under emulation.

```bash
curl -fsSL https://raw.githubusercontent.com/lensapp/prism-agent/main/install.sh | sh

```

```powershell
irm https://raw.githubusercontent.com/lensapp/prism-agent/main/install.ps1 | iex

```

--------------------------------

### nexusctl sandbox start

Source: https://docs.lenshq.io/lens-agents/reference/cli

Starts a sandbox. Idempotent lifecycle control.

```APIDOC
## nexusctl sandbox start

### Description
Starts a sandbox. Idempotent lifecycle control.

### Method
CLI command

### Command
`nexusctl sandbox start`

### Arguments
- `<slug-or-id>` - The slug or id of the sandbox to start.

### Global Flags
- `--server <url>` - Platform URL. Overrides `NEXUS_URL` and stored credentials.
- `-o, --output <format>` - Output format: `table` (default), `json`, or `yaml`.
- `-h, --help` - Help at any level.

### Environment Defaults
- `NEXUS_URL` - Platform URL
- `NEXUS_ORG` - Organization
- `NEXUS_PROJECT` - Project
```

--------------------------------

### Install Prism Agent on Windows

Source: https://docs.lenshq.io/prism-agent/installation

One-line installer for Windows using PowerShell.

```powershell
irm https://raw.githubusercontent.com/lensapp/prism-agent/main/install.ps1 | iex
```

--------------------------------

### Example response for Windows

Source: https://docs.lenshq.io/troubleshooting/pod-shell-error

Example output from the 'where.exe kubectl' command on Windows, showing the path to the kubectl binary.

```text
C:\Users\<user-name>\AppData\Roaming\Lens\binaries\kubectl\1.32\kubectl.exe
```

--------------------------------

### Example response for macOS and Linux

Source: https://docs.lenshq.io/troubleshooting/pod-shell-error

Example output from the 'which kubectl' command on macOS and Linux, showing the path to the kubectl binary.

```text
/Users/<user-name>/Library/Application Support/Lens/binaries/kubectl/1.33/kubectl
```

--------------------------------

### GET /installation

Source: https://docs.lenshq.io/lens-agents/reference/api

Retrieves the installation status. This endpoint is used to check whether the Lens installation is active or requires activation.

```APIDOC
## GET /installation

### Description
Retrieves the installation status.

### Method
GET

### Endpoint
/installation

### Response
#### Success Response (200)
- **status** (string) - The installation status (e.g., active, pending activation).

#### Response Example
{
  "status": "active"
}
```

--------------------------------

### Export Bedrock credential for installer

Source: https://docs.lenshq.io/prism-agent/installation/native

Export a Bedrock model provider credential before running the installer so it is baked into ~/.prism/.env and the background service starts with working credentials. If omitted, the installer writes empty placeholders that must be edited manually.

```bash
export AWS_BEARER_TOKEN_BEDROCK=<YOUR-KEY>

```

--------------------------------

### nexusctl sandbox init

Source: https://docs.lenshq.io/lens-agents/reference/cli

Writes a commented example spec to stdout, or to a file with --out.

```APIDOC
## nexusctl sandbox init

### Description
Writes a commented example spec to stdout, or to a file with `--out`.

### Method
CLI command

### Command
`nexusctl sandbox init`

### Options
- `--out` - Write the spec to a file instead of stdout.

### Global Flags
- `--server <url>` - Platform URL. Overrides `NEXUS_URL` and stored credentials.
- `-o, --output <format>` - Output format: `table` (default), `json`, or `yaml`.
- `-h, --help` - Help at any level.

### Environment Defaults
- `NEXUS_URL` - Platform URL
- `NEXUS_ORG` - Organization
- `NEXUS_PROJECT` - Project
```

--------------------------------

### GET /inference/providers

Source: https://docs.lenshq.io/lens-agents/reference/api

Lists the configured inference providers for the deployment. This endpoint returns the default provider and the list of backends that the installation has configured.

```APIDOC
## GET /inference/providers

### Description
Lists the configured inference providers for the deployment.

### Method
GET

### Endpoint
/inference/providers

### Response
#### Success Response (200)
- **defaultProvider** (string) - The default provider used when no provider is specified.
- **providers** (array) - List of configured provider names.

#### Response Example
{
  "defaultProvider": "openai",
  "providers": ["openai", "bedrock"]
}
```

--------------------------------

### GET /agents/plugins

Source: https://docs.lenshq.io/prism-agent/features/plugins

Returns an array of installed plugins with their version, description, contributed skills and MCP servers, and any load problems in the diagnostics field.

```APIDOC
## GET /agents/plugins

### Description
Returns the same information as the /plugins command, as an array. Each plugin includes its version, description, contributed skills and MCP servers, and any load problems in the diagnostics field.

### Method
GET

### Endpoint
/agents/plugins

### Response
#### Success Response (200)
- **array** - Array of plugin objects, each containing version, description, skills, MCP servers, and diagnostics.

#### Response Example
{
  "plugins": [
    {
      "name": "example-plugin",
      "version": "1.0.0",
      "description": "Example plugin",
      "skills": [],
      "mcpServers": [],
      "diagnostics": []
    }
  ]
}
```

--------------------------------

### Discover commands with --help

Source: https://docs.lenshq.io/lens-agents/install/cli

Shows help at every level of the CLI. This is the authoritative reference for the installed version.

```bash
nexusctl --help
nexusctl sandbox --help
nexusctl sandbox create --help
```

--------------------------------

### Make AppImage executable and run

Source: https://docs.lenshq.io/k8slens/getting-started/install-lens

Makes the downloaded AppImage executable and runs it.

```bash
chmod +x <FILE-NAME.AppImage>
./<FILE-NAME.AppImage>

```

--------------------------------

### GET /projects/{projectId}/oauth-applications

Source: https://docs.lenshq.io/lens-agents/reference/api

Lists OAuth applications configured for the install. This endpoint is part of the connections group. It returns no client secrets.

```APIDOC
## GET /projects/{projectId}/oauth-applications

### Description
Lists OAuth applications configured for the install. This endpoint is part of the connections group. It returns no client secrets.

### Method
GET

### Endpoint
/projects/{projectId}/oauth-applications

### Parameters
#### Path Parameters
- **projectId** (string) - Required - Project identifier

```

--------------------------------

### POST /v1/projects/{project_id}/sandboxes/{sandbox_id}/start

Source: https://docs.lenshq.io/lens-agents/sandboxes

Starts a stopped sandbox. Resumes on the same persistent disk. Idempotent.

```APIDOC
## POST /v1/projects/{project_id}/sandboxes/{sandbox_id}/start

### Description
Starts a stopped sandbox. Resumes on the same persistent disk. Idempotent.

### Method
POST

### Endpoint
https://agents.example.com/v1/projects/{project_id}/sandboxes/{sandbox_id}/start

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project containing the sandbox.
- **sandbox_id** (string) - Required - The ID of the sandbox to start.

### Request Example
```
curl -fsS -X POST -H "Authorization: Bearer $LENS_AGENTS_TOKEN" \
  https://agents.example.com/v1/projects/$PROJECT_ID/sandboxes/$SANDBOX_ID/start
```

### Response
#### Success Response (200)
No response body is documented.

### Error Handling
No error responses are documented.
```

--------------------------------

### Setup prompt for coding agent

Source: https://docs.lenshq.io/lens-agents/getting-started/try-locally-ai

The prompt to provide to your coding agent to initiate the automated installation of the Lens Agents admin skill and platform.

```text
Install the Lens Agents admin skill from
https://github.com/lensapp/lens-agents-admin-skill/tree/main/lens-agents-admin
and follow it to set up Lens Agents.
```

--------------------------------

### Install nexusctl CLI

Source: https://docs.lenshq.io/lens-agents/install/cli

Downloads and installs the nexusctl binary from the platform server, verifies it against the published checksum, and writes ~/.nexus/config.json. Requires curl, gzip, and sha256sum or shasum. The installer is rendered per request with the server's URL and version.

```bash
curl -fsSL https://agents.example.com/install.sh | sh

```

--------------------------------

### Start dedicated minikube cluster for Lens Agents

Source: https://docs.lenshq.io/lens-agents/getting-started/try-locally-manual

Starts a dedicated minikube cluster named 'lens-agents' with Docker driver, 4 CPUs, and 6GB memory, then switches the kubectl context and verifies cluster info. This cluster is used for all subsequent commands in the guide.

```bash
minikube start -p lens-agents --driver=docker --cpus=4 --memory=6g
kubectl config use-context lens-agents
kubectl cluster-info

```

--------------------------------

### Configure credential injection with rules

Source: https://docs.lenshq.io/lens-agents/connections/credentials

An example of a credential injection configuration that restricts the 'X-API-Key' header to only 'GET' requests under the '/v1/reports/' path for the specified domain.

```json
{
  "domain": "api.internal.example.com",
  "headerName": "X-API-Key",
  "headerFormat": "{value}",
  "rules": [
    { "method": "GET", "path": "/v1/reports/*" }
  ]
}
```

--------------------------------

### Initialize and create sandbox with nexusctl

Source: https://docs.lenshq.io/lens-agents/sandboxes/spec

Initializes a commented spec template and creates a sandbox from it. `sandbox init` writes a template; `-f -` reads from stdin. Flags override file settings, so one file plus `--image` covers per-environment differences.

```bash
nexusctl sandbox init > sandbox.yaml
nexusctl sandbox create --project production -f sandbox.yaml
```

--------------------------------

### Install nexusctl CLI with custom install directory

Source: https://docs.lenshq.io/lens-agents/install/cli

Installs nexusctl to a custom directory by setting NEXUSCTL_INSTALL_DIR. The installer will tell you if the directory is not on your PATH.

```bash
curl -fsSL https://agents.example.com/install.sh \
  | NEXUSCTL_INSTALL_DIR=/usr/local/bin sh

```

--------------------------------

### Install nexusctl

Source: https://docs.lenshq.io/lens-agents/reference/cli

Use this command to install the CLI from your platform, ensuring the version matches your specific environment.

```bash
curl -fsSL https://agents.example.com/install.sh | sh
```

--------------------------------

### Codex CLI Installation

Source: https://docs.lenshq.io/prism-agent/release-notes

Command to install the Codex CLI for native installations.

```bash
npm install -g @openai/codex
```

--------------------------------

### Prompt to list policy bindings

Source: https://docs.lenshq.io/lens-agents/platform-admin/policy-bindings

Example prompt for an agent to list policy bindings in the production project and describe who each applies to.

```text
List the policy bindings in the production project and tell me who
each one applies to.

```

--------------------------------

### Activate installation via CLI

Source: https://docs.lenshq.io/lens-agents/install/activation

Use the nexusctl command to initiate the activation device flow. The command provides a verification URL and code to complete the process in a browser.

```bash
nexusctl installation activate --server https://agents.example.com
```

--------------------------------

### Silent installation for single user

Source: https://docs.lenshq.io/k8slens/getting-started/install-lens

Run the installer with the /S flag to perform a silent installation for the current user.

```bash
Lens.Setup.<RELEASE-ID>.exe /S
```

```bash
Lens.Setup.<RELEASE-ID>.exe /S /currentuser
```

--------------------------------

### Install Lens via Snap

Source: https://docs.lenshq.io/k8slens/getting-started/install-lens

Installs the Lens K8S IDE snap package with classic confinement.

```bash
sudo snap install kontena-lens --classic

```
Tokens:
Raw