Skip to content

andrhamm/strider-cli

Repository files navigation

Strider CLI

A command-line interface companion for Strider VTT, a virtual tabletop designed for solo-roleplaying The One Ring™ Second Edition using Strider mode.

About

This CLI tool helps you manage your Strider VTT sessions, characters, and game data from the comfort of your terminal. It provides a streamlined interface for common tasks and automates routine operations.

This is a frontend client that works in conjunction with other Strider components, see below.

Prerequisites

Before using this CLI, ensure you have:

  1. A running instance of strider-mcp
  2. A running instance of strider-agent
  3. Valid API credentials for the agent service

Installation

# Clone the repository
git clone https://github.com/andrhamm/strider-cli.git
cd strider-cli

# Install dependencies
yarn install

# Link the CLI globally
yarn link

Usage

# Run the CLI
strider

# Get help
strider --help

Development

# Install dependencies
yarn install

# Run type checking
yarn typecheck

# Run linting
yarn lint

# Format code
yarn format

Environment Variables

Create a .env file in the project root with the following variables:

AGENT_API_BASE_URL=your_api_url
CLIENT_ID=your_client_id
CLIENT_SECRET=your_client_secret
LOG_LEVEL=debug

Project Structure

This CLI is part of a larger ecosystem:

  • strider-cli (this repo) - Command-line interface for users to play (eventually there will be a desktop application)
  • strider-agent - REST API backed by a multi-agent AI (python)
  • strider-mcp - Agent tools, Oauth Provider, and game state API (typescript)

Disclaimer

This is a personal project and is not affiliated with, endorsed by, or connected to Free League Publishing or the Tolkien Estate. The One Ring™ and its associated names, characters, and places are trademarks of Middle-earth Enterprises LLC and are used under license by Free League Publishing.

This software is provided for personal use only and is not for sale or commercial distribution. All rights to The One Ring™ and related intellectual property belong to their respective owners.

License

This project is licensed under the CC BY-NC-SA 4.0 license.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

About

Command line VTT for solo playing The One Ring Second Edition

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published