Skip to main content

Terminus CLI: An autonomous AI agent for terminal-based task execution

Project description

Terminus CLI

Terminus CLI is a CLI agent for terminal-based task execution. It can be used as a standalone tool, although it was primarily designed as a research-preview agent for evaluating the abilities of language models to power autonomous agents in the terminal.

Installation

Prerequisites

  • Python >=3.12
  • tmux (required for terminal session management)

Installing tmux

Terminus requires tmux to manage terminal sessions. Install it using your system's package manager:

macOS:

brew install tmux

Ubuntu/Debian:

sudo apt-get install tmux

Fedora:

sudo dnf install tmux

Arch Linux:

sudo pacman -S tmux

Install Terminus

uv tool install terminus-ai

or

pip install terminus-ai

Usage

Command Line Interface

Terminus provides a CLI for quick testing and demonstration:

# Basic usage
terminus "Create a file hello.txt with Hello World"

# With options
terminus "Create a file hello.txt" \
  --model openai/gpt-4o \
  --logs-dir ./logs \
  --parser json \
  --temperature 0.7

# Show help
terminus --help

Note:

  • The CLI runs directly on your local system using tmux (no Docker required)
  • Perfect for quick tasks, testing, and automation

Programmatic Usage

You can also use Terminus programmatically in Python:

from terminus import Terminus
from pathlib import Path

agent = Terminus(
    logs_dir=Path("./logs"),
    model_name="anthropic/claude-sonnet-4",
    parser_name="json",  # or "xml"
    temperature=0.7,
    max_turns=100,
    enable_summarize=True,
)

Configuration Options

  • model_name: The LLM model to use (required)
  • parser_name: Response format - "json" or "xml" (default: "json")
  • temperature: Sampling temperature (default: 0.7)
  • max_turns: Maximum number of agent turns (default: 1000000)
  • enable_summarize: Enable context summarization when limits are reached (default: True)
  • api_base: Custom API base URL (optional)
  • collect_rollout_details: Collect detailed token-level rollout data (default: False)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terminus_ai-2.0.3.tar.gz (33.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terminus_ai-2.0.3-py3-none-any.whl (38.1 kB view details)

Uploaded Python 3

File details

Details for the file terminus_ai-2.0.3.tar.gz.

File metadata

  • Download URL: terminus_ai-2.0.3.tar.gz
  • Upload date:
  • Size: 33.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for terminus_ai-2.0.3.tar.gz
Algorithm Hash digest
SHA256 13a79d7c153eb1344b3d449b25a722129bbdeea1f212323773846e6780664659
MD5 9c9f4aa0e9e780434a6ac5ecb4f6493d
BLAKE2b-256 467626f97766dc77b65d8f67d07a1ce60f10488f97c1319e175496ad7a8474d6

See more details on using hashes here.

File details

Details for the file terminus_ai-2.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for terminus_ai-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3c690c4e609607a802cdd136267bec6ecf8ca0d6a03ff9ba762220eea1a7316f
MD5 fc22692dc21e961af47b6c0f19c11d39
BLAKE2b-256 7dbd47102c332aca8d4a33e36eb38467263d5b22258ccddceb707e01b308b7fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page