Documentation
Docs/Configuration/Lens CLI Setup

Lens CLI Setup

Configure the NxtOne Lens CLI for your environment, language, and deployment topology.

The nxtone-lens CLI tool manages your local developer workspaces, links your repository to the platform, and verifies connectivity.

1. Authentication

Authenticate your local terminal with the NxtOne platform to fetch and store scoped API keys:

bash
nxtone login

This command opens a browser window where you can log in. After authentication, a secure token is written to ~/.nxtone/config.json.

2. Initializing a Workspace

Initialize a new project workspace in your root code directory:

bash
nxtone init

This creates a local nxtone.toml file where you can define project metadata and exclusions.

3. Core Commands Reference

  • nxtone verify: Validates credentials, checks if the local environment is healthy, and tests connection to the server ingest endpoints.
  • nxtone sync: Links the workspace to the platform and syncs project code metadata for use in investigation screens.
  • nxtone run -- [command]: Runs a local process under the NxtOne instrumentation context (injecting environment keys and profiles automatically).
Automatic Environment Variables: The CLI loads settings from your nxtone.toml and injects them as NXTONE_* environment variables automatically when running processes via nxtone run.
On This Page
What is NxtOne?Key FeaturesQuick StartInstall the agentAnnotate your applicationConfigure API keyConfiguration ReferenceAPI ExampleSupported StackLanguages & FrameworksNext Steps