Skip to content

quickstart.md

Latest commit

 

History

History
71 lines (48 loc) · 2.02 KB

quickstart.md

File metadata and controls

71 lines (48 loc) · 2.02 KB
Raw

Quickstart

AgentX is a terminal chat agent built on the OpenAI Responses API over WebSocket transport. For most users, the simplest path is: install it globally, run agentx-setup once, then start agentx. It also includes an experimental web GUI, but that is still a proof of concept and a lot of things are broken or incomplete. A separate agentx-setup helper can edit .env values and manage the Linux GUI service.

Start the CLI

If you installed the package globally, use:

agentx

If you are working from the repository root, use:

node agentx.mjs

Optional: start the web GUI

This is mainly for repository-local development, not the global install path:

npm run start:gui

Then open the local port it prints, usually http://localhost:3100. Use the CLI if you want the more reliable path; the GUI is still rough.

Optional: run the setup helper

agentx-setup

Use that to edit .env values and manage the GUI service on Linux.

Quick flags

  • agentx --help or agentx -h shows quick help
  • agentx --version or agentx -v prints the package version
  • agentx --debug prints raw websocket logs and suppresses live status lines

Before you begin

Set your API key in the shell environment, or let agentx-setup write it into a local .env file for you:

export agentx_api_key="your-key-here"
# or: export AGENTX_API_KEY="your-key-here"

AgentX prefers agentx_api_key and falls back to AGENTX_API_KEY. The launchers also load .env when present.

First run

  1. Start AgentX.
  2. Type a normal message and press Enter.
  3. AgentX sends that message to OpenAI.
  4. The response streams into the terminal as it is generated.

What to expect

  • The prompt shows your current working directory.
  • AgentX waits for your first message before contacting OpenAI.
  • Tool calls may stream command arguments and shell summaries live.
  • If .agentx_responseid exists, the session resumes automatically. If it contains pending tool calls, AgentX asks how you want to continue.