Sign in Request access
Skip to content

Start here

Install and sign in

Install NetConverter CLI, connect an enabled account, and check what your credential can do.

Updated November 2, 2026 · Terminal guides: CLI 0.7.0

Before you start

You need an approved NetConverter account or an API key with the required access. AI integrations additionally need MCP access enabled by an administrator. Start with synthetic files and read the data-flow guide.

Platform evidence: macOS is the exercised platform in the published terminal guide. Windows installation is documented, but full Windows acceptance remains pending. Check release verification for your setup.

Install the CLI

The existing installers install the CLI, guide sign-in and offer assistant connections. Review the script before running it: macOS/Linux script or PowerShell script.

macOS and Linux

curl -LsSf https://netconverter.ai/install.sh | sh

Windows PowerShell

irm https://netconverter.ai/install.ps1 | iex

For a manual installation with uv already installed:

uv tool install --python 3.12 netconverter-cli
netconverter --version

Upgrading from netconverter-terminal 0.1.x? Uninstall that package first with uv tool uninstall netconverter-terminal. Saved credentials use the existing NetConverter Terminal credential-store name.

Sign in

netconverter login --clerk
netconverter whoami
netconverter capabilities

On a machine without a browser, use netconverter login --clerk --device. For an API key, run netconverter login and enter it at the hidden prompt. Never paste credentials into an AI conversation.

The CLI presents its license on first use. Follow that prompt before connecting an assistant. If a key and browser sign-in are both stored, the stored API key takes precedence; whoami helps identify the active connection.

Choose a workspace

Create a private folder for synthetic configurations and open your terminal there. Running netconverter opens the interactive app in that folder. Opening the app does not submit a job.

Headless credential storage

The CLI prefers the OS credential store. When one is unavailable, it can use a passphrase-encrypted credential file or keep credentials in memory for the session. netconverter login --store file selects encrypted file storage. The assistant’s bridge process must be able to access the chosen store; see credential troubleshooting.

Run your first validation

Continue with the synthetic example. Assistant setup comes after the basic sign-in and capability checks work.

Source and release context: Quick start · Credential storage