Skip to content

getting-started.md

Latest commit

 

History

History
81 lines (60 loc) · 2.79 KB

getting-started.md

File metadata and controls

81 lines (60 loc) · 2.79 KB
Raw

Installation

NeoAgent supports macOS and Linux hosts. It installs as a long-running service, so use a machine that remains online when you expect automations, messaging, or remote access to work.

Requirements

  • Node.js 20 or newer with npm
  • A macOS or Linux user account that can install packages
  • Enough disk and memory for the models and runtime you choose
  • Docker for the isolated browser and terminal runtime

The isolated browser and CLI run each user's guest agent in a Docker container. Install Docker first; the NeoAgent installer detects it and pre-builds the guest runtime image (browser and dependencies baked in) so the first browser or CLI action is instant. If Docker is missing, the rest of NeoAgent still installs and the cloud browser/CLI become available once Docker is running.

# macOS — Docker Desktop
# https://www.docker.com/products/docker-desktop/

# Ubuntu or Debian — Docker Engine
# https://docs.docker.com/engine/install/

Install NeoAgent

npm install -g neoagent
neoagent install

neoagent install checks the host, creates the runtime configuration, installs application dependencies and supported system tools, prepares the isolated runtime, and registers a launchd or systemd user service when available.

Read the post-install actions printed by the command. They describe anything the installer could not complete automatically.

Open http://localhost:3333 on the server. For remote access, configure HTTPS and PUBLIC_URL before connecting integrations or mobile clients.

First run

  1. Create the first user account.
  2. Open Settings > AI Providers.
  3. Configure a hosted provider or connect local Ollama.
  4. Select a model and send a message in Chat.
  5. Open Settings > Tool Permissions and review the approval policy before enabling browser, shell, file-write, desktop, or Android actions.

The first isolated-runtime boot downloads and prepares an Ubuntu image. It can take several minutes and is not required for a basic model-only chat.

Check the installation

neoagent status
neoagent logs

status reports the install path, configuration, release channel, service state, and server health. Use logs on the machine running NeoAgent; logs from another computer do not describe the remote server.

Global npm permission errors

If npm install -g fails with EACCES on macOS, install Node through nvm so global packages live in your user directory. Running the npm command with sudo also works, but makes later package ownership harder to manage.

Next steps