Skip to main content

CLI for the Traylinx Agent Network - Create, validate, and publish agents

Project description

๐Ÿš€ Traylinx CLI

Traylinx CLI Logo

The command-line interface for the Traylinx Agent Network. Build, run, and share AI agents with Docker-powered simplicity.

Version: 0.2.1 | Python: 3.11+ | Status: Production-Ready

Status PyPI


๐Ÿ“š Documentation Navigation

Document Description Audience
๐Ÿ—๏ธ Architecture Plugin System & Command Structure Architects / Developers
๐Ÿ“– Command Reference All CLI Commands Developers
๐Ÿ”Œ Setup Guide Installation & Configuration Users / DevOps

Installation

Instant Execution (No Install)

Run without installing using uvx:

uvx traylinx-cli --help

Using pipx (Recommended)

pipx installs CLI tools in isolated environments:

pipx install traylinx-cli

Using Homebrew (macOS/Linux)

brew tap traylinx/traylinx
brew install traylinx

Using pip

pip install traylinx-cli

๐Ÿ’ก Short Alias: After installation, you can use tx as a shortcut:

tx --help    # Same as traylinx --help
tx run       # Same as traylinx run

Quick Start

# Create a new agent
traylinx init my-agent
cd my-agent

# Run locally with Docker
traylinx run

# View logs
traylinx logs

# Stop the agent
traylinx stop

๐Ÿณ Docker-Powered Agent Commands

Run agents anywhere with zero configuration โ€” just Docker.

Command Description
traylinx run ๐Ÿš€ Start agent via Docker Compose
traylinx stop โน๏ธ Stop running agent containers
traylinx logs ๐Ÿ“‹ Stream agent logs
traylinx list ๐Ÿ“Š List all running agents

Run Options

traylinx run                  # Run in background (detached)
traylinx run --no-detach      # Run in foreground (see logs)
traylinx run --prod           # Use production config (Postgres)
traylinx run --native         # Skip Docker, use local Python

๐Ÿ“ฆ Publishing & Sharing Agents

Share your agents with anyone via GitHub Container Registry.

Command Description
traylinx publish ๐Ÿ“ฆ Build multi-arch image + push to GHCR
traylinx pull <agent> โฌ‡๏ธ Download and run any published agent

Publish Your Agent

cd my-agent
traylinx publish
# โ†’ Building for linux/amd64,linux/arm64...
# โ†’ Pushing to ghcr.io/traylinx/my-agent:1.0.0
# โ†’ โœ“ Published!

Run Any Agent

# The "Ollama experience" for agents
traylinx pull weather-agent
# โ†’ Pulling from ghcr.io/traylinx/weather-agent:latest
# โ†’ โœ“ Agent running at http://localhost:8000

Core Commands

Command Description
traylinx init <name> Create new agent project
traylinx validate Validate traylinx-agent.yaml
traylinx login Log in to your Traylinx account
traylinx status Show CLI status and config
traylinx --help Show all commands

Configuration

Environment Variables

export TRAYLINX_ENV=dev                           # dev, staging, prod
export TRAYLINX_REGISTRY_URL=http://localhost:8000  # Override registry URL
export TRAYLINX_AGENT_KEY=my-agent                # Your agent key
export TRAYLINX_SECRET_TOKEN=your-token           # From Sentinel

Config File

Create ~/.traylinx/config.yaml:

registry_url: https://api.traylinx.com
credentials:
  agent_key: your-agent-key
  secret_token: your-secret-token

Architecture

traylinx/
โ”œโ”€โ”€ cli.py            # Main CLI entry point
โ”œโ”€โ”€ commands/
โ”‚   โ”œโ”€โ”€ init.py       # Create projects
โ”‚   โ”œโ”€โ”€ validate.py   # Validate manifests
โ”‚   โ”œโ”€โ”€ publish.py    # Publish to catalog
โ”‚   โ””โ”€โ”€ docker_cmd.py # Docker-powered commands
โ”œโ”€โ”€ utils/
โ”‚   โ”œโ”€โ”€ docker.py     # Docker detection + compose
โ”‚   โ””โ”€โ”€ registry.py   # GHCR integration
โ”œโ”€โ”€ api/
โ”‚   โ””โ”€โ”€ registry.py   # API client
โ”œโ”€โ”€ models/
โ”‚   โ””โ”€โ”€ manifest.py   # Pydantic models
โ””โ”€โ”€ templates/        # Project templates

Development

# Install dev dependencies
uv sync

# Run tests
uv run pytest

# Run CLI locally
uv run traylinx --help

Requirements

  • Python 3.11+ (for CLI)
  • Docker (for run, publish, pull commands)
  • Docker Buildx (for multi-arch builds, optional)

License

MIT License - Traylinx ยฉ 2025

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

traylinx_cli-0.2.1.tar.gz (52.5 kB view details)

Uploaded Source

Built Distribution

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

traylinx_cli-0.2.1-py3-none-any.whl (60.0 kB view details)

Uploaded Python 3

File details

Details for the file traylinx_cli-0.2.1.tar.gz.

File metadata

  • Download URL: traylinx_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 52.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for traylinx_cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f7bd1e5dbbeddadb09750418751d4fd343dcdc4feb09df44095323152b4f0c2a
MD5 08908a00638e8a6c28b36aa77b55d871
BLAKE2b-256 bc9384ed0f3a267715b025b0c3b2c207aa26baa8d8a2a3c957024fa31a0f50c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for traylinx_cli-0.2.1.tar.gz:

Publisher: release.yml on traylinx/traylinx-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file traylinx_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: traylinx_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 60.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for traylinx_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ce5ea48669a4d2c2ee7f100d171e984ed3e9d8c92c8cef49bd65c18a11504e01
MD5 009a2b2b320ff1a5e537f2c7052d0d5e
BLAKE2b-256 50fd7c7808551f8fce51c927b6ca8093c8ff61023b6c18fc14f8b7611f2ff647

See more details on using hashes here.

Provenance

The following attestation bundles were made for traylinx_cli-0.2.1-py3-none-any.whl:

Publisher: release.yml on traylinx/traylinx-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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