Product • Syslog beacon CLI

AgentSOCSyslog Beacon CLI

Lightweight, background-ready log forwarder. Save your API key and environment (production by default), run in the foreground, or install as a service—without leaving your terminal.

Installconfigrunbeacon status

agentsoc — bash

The animation ends with beacon status: service state (systemd / launchd) plus forwarding counters from stats.json.

Stream syslog

Forward host and system logs to AgentSOC—production ingest or localhost dev—without choosing raw webhook URLs.

CLI-first

Configure credentials, run in the foreground, or install as a system service from one tool.

Production paths

One-line curl install, optional systemd or launchd service—everything stays on the host.

Requirements

You need

Node.js 16+

npm

(macOS, Linux, or Windows)

Installation

Quick install

Install the published package @agentsoc/beacon globally. Scripts are served from /connectors/ on this site; the CLI source lives in the platform monorepo. An animated agentsoc — bash walkthrough is in the hero above (Aceternity Terminal).

macOS / Linux

curl -fsSL https://agentsoc.com/connectors/beacon.sh | bash

Windows PowerShell

irm https://agentsoc.com/connectors/beacon-install.ps1 | iex

Or: npm install -g @agentsoc/beacon · beacon-install.bat

From a git clone

If you already have platform.agentsoc.com checked out, build and link the npm package locally:

cd apps/connectors/syslog-beacon-cli
bun install && bun run build:simple && npm install -g .

Installation scripts

The TypeScript CLI source lives in platform.agentsoc.com (apps/connectors/syslog-beacon-cli). Hosted install scripts are on this site under /connectors/.

@agentsoc/beacon/connectors/beacon.sh · beacon-install.ps1 · beacon-install.bat

Usage

The CLI configures the forwarder, runs it in the foreground, or installs it as a system service.

Configure

Saves your API key and target environment locally. Ingest URLs are fixed per environment (not editable as a free-form URL in the CLI).

beacon config --key <key> [--env production|development]

Parameters

--key / -k <key>: API key (required; e.g. sk_1234567890abcdef)
--env / -e production|development: ingest target (default production → https://ingest.agentsoc.com/api/v1/webhooks/syslog; development → http://localhost:8110/api/v1/webhooks/syslog)

Examples

beacon config --key sk_1234567890abcdef
beacon config --key sk_1234567890abcdef --env development

The syslog-beacon command is the same CLI (npm installs both names). For a single run, you can override the environment with AGENTSOC_ENV (production / development).

Run (foreground)

Tune batch size and flush interval for your workload.

beacon run [options]

--batch-size <n>: logs per batch (default 25)
--flush-ms <n>: flush interval in ms (default 2000)

beacon run --batch-size 50 --flush-ms 5000

You can set AGENTSOC_API_KEY instead of saving a key in config. AGENTSOC_ENV overrides the saved environment for that process. Advanced setups may set AGENTSOC_INGEST_URL to override the resolved webhook URL.

Status

Service state plus forwarding counters from stats.json (same folder as config.json).

beacon status

Counters include log lines forwarded, batch success/fail counts, and last update time—see the hero terminal for a sample of the output.

Install service

Background daemon via systemd (Linux) or launchd (macOS).

beacon install

Source & distribution

CLI source is in platform.agentsoc.com (apps/connectors/syslog-beacon-cli). Public install scripts (/connectors/) live in this repo under public/connectors/.

From the connector directory in the platform repo, run ./test-logs.sh while beacon run is active to exercise the forwarder locally.

Need an API key or platform access?

Production and dev ingest endpoints are built into the CLI; explore the platform overview or reach out for keys and setup.

AgentSOC Platform Contact us