Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bortexcode) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Bortex Code CLI

Terminal AI coding assistant powered by https://bortex.site.

Install

After publishing to npm:

npm install -g bortexcode

Fallback installer:

curl -fsSL https://bortex.site/install.sh | bash

Windows PowerShell:

irm https://bortex.site/install.ps1 | iex

Direct tarball fallback:

npm install -g https://bortex.site/bortex-code/bortex-code-latest.tgz

bortexcode --login

Or provide an API key:

bortexcode --api-key <YOUR_API_KEY>
export BORTEX_API_KEY=<YOUR_API_KEY>

Usage

bortexcode
bortexcode "explain this function"
bortexcode --agent "refactor src/utils.js"

REPL Commands

Press / at the beginning of the prompt to open the command menu. Press Tab to complete slash commands.

Common commands:

/agent on|off
/status
/commands
/help
/llm-config show
/llm-config sync
/exit

Options

-a, --agent         Agent mode
    --chat          Chat mode (default)
-u, --url <url>     Bortex server URL
    --api-key <k>   API key
    --login         Open browser login
-m, --model <name>  Force a specific LLM model
    --api-url <u>   Custom LLM endpoint
    --offline       Local mode
    --verbose       Show routing details
    --progress      Show server progress events
    --no-spinner    Disable spinner
    --icons         Enable icon output
    --check-update  Check for updates now
    --no-update-check
                    Disable startup update check
-v, --version       Show version
-h, --help          Show help

Updates

Bortex Code checks for newer versions on startup. When an update is available, it asks before installing it globally with npm.

bortexcode --check-update
bortexcode --no-update-check

Environment

BORTEX_URL
BORTEX_API_KEY
BORTEX_CLI_ICONS=1
BORTEX_NO_UPDATE_CHECK=1

bortexcode