Skip to content

v0.1.0

Choose a tag to compare

@ruslanmv ruslanmv released this 01 Aug 17:33
· 40 commits to master since this release

Matrix CLI v0.1.0

First public release of the Matrix CLI — a command-line and interactive shell for discovering, inspecting, installing, and managing agents/tools from Matrix Hub.

Highlights

  • ⚡ Interactive Matrix Shell (REPL) with history & autocompletion
  • 🔍 Search the Hub catalog with rich filters
  • 📋 Show full metadata for agents/tools
  • 🛠️ Install entities into your project (writes adapters, integrates with MCP-Gateway)
  • 📑 List entities from Hub or Gateway
  • 🌐 Manage Remotes (list/add/remove/ingest)
  • 🎛️ Session options available at startup and within REPL: --version, --rain/--no-rain, --no-repl
  • 🧠 Robust, user-friendly REPL: redundant matrix prefix accepted; help does not clear the screen

Installation

# Recommended
pipx install matrix-cli

# Or
pip install matrix-cli

Requires: Python 3.11+


Quick Start

# Enter the interactive Matrix Shell
matrix

# One-shot usage
matrix --version
matrix search "pdf summarizer" --type agent --limit 5

# Screensaver (press any key to return)
matrix screensaver

Configuration

Matrix CLI reads ~/.matrix/config.toml and supports env/flag overrides.

[registry]
base_url = "http://localhost:7300"
token = "YOUR_MATRIX_TOKEN"      # optional

[gateway]
base_url = "http://localhost:7200"
token = "YOUR_GATEWAY_TOKEN"     # optional

[cache]
dir = "~/.cache/matrix"
ttl_seconds = 14400

Environment overrides:

export MATRIX_BASE_URL=http://hub.example.com
export MATRIX_TOKEN=...
export MCP_GATEWAY_URL=http://gateway.example.com
export MCP_GATEWAY_TOKEN=...

Core Commands

  • matrix search "<query>" [--type ... --capabilities ... --frameworks ... --mode ... --limit N]
  • matrix show <type:name[@version]> [--json]
  • matrix install <type:name[@version]> --target ./path
  • matrix list --type [agent|tool|server] --source [hub|gateway]
  • matrix remotes [list|add|remove|ingest] [...]

REPL helpers: help, help <command>, clear, exit|quit|close


Compatibility

  • Matrix Hub (FastAPI) at MATRIX_BASE_URL
  • Matrix Python SDK >=0.1,<1.0
  • Optional MCP-Gateway integration (for installs/listing)

Notable UX Details

  • Help output does not clear the screen (use clear if desired)
  • Options-first parsing in REPL (e.g., --no-rain, --version) works reliably
  • Redundant leading matrix token accepted in REPL (e.g., matrix exit)
  • Screensaver uses the same animation style as startup and preserves prior output

Known Issues

  • Terminal rendering performance can vary across environments. For consistent visuals, pin rich and prompt_toolkit versions in your environment if needed.
  • When running inside certain terminals on Windows, key detection for the screensaver may have a slight delay before returning to the prompt.

Links

Thank you for trying Matrix CLI! Please report bugs, request features, and share feedback via GitHub Issues.