Skip to main content

Play TextLands from your terminal

Project description

TextLands CLI

Play TextLands from your terminal.

Installation

Quick Install (Recommended)

curl -fsSL https://textlands.com/install.sh | bash

Package Managers

# pip (Python 3.10+)
pip install textlands

# Homebrew (macOS/Linux)
brew tap MindFortressInc/textlands
brew install textlands

# npm (Node.js 16+)
npm install -g textlands

Download Binary

Pre-built binaries available on GitHub Releases:

Platform Download
macOS (Apple Silicon) textlands-macos-arm64
macOS (Intel) textlands-macos-x64
Linux (x64) textlands-linux-x64
Windows (x64) textlands-windows-x64.exe

Quick Start

# List available realms
textlands realms

# Start playing
textlands play

# Or jump straight into a realm
textlands play <realm-id>

Commands

Command Description
textlands realms List available realms
textlands play [REALM] Start or resume playing
textlands status Show current session
textlands login Authenticate with API key
textlands logout Clear credentials
textlands config Configure settings

In-Game Commands

While playing:

  • /look or /l - Look around
  • /inventory or /i - Check inventory
  • /rest or /r - Rest and recover
  • /help or /h - Show help
  • /quit or /q - Exit game

Or just type what you want to do:

  • "search the room"
  • "talk to the bartender"
  • "attack the goblin"

Configuration

The CLI stores config in ~/.textlands/:

  • config.json - Settings and session state
  • API keys are stored in system keyring when available

Environment variables:

  • TEXTLANDS_API_URL - Override API URL
  • TEXTLANDS_API_KEY - Set API key
  • TEXTLANDS_INSTALL_DIR - Custom install directory (for install.sh)

Development

# Clone and install
git clone https://github.com/MindFortressInc/textlands-cli
cd cli
pip install -e ".[dev]"

# Run tests
pytest

# Local API testing
textlands config --api-url http://localhost:8002

# Build binary locally
pip install pyinstaller
pyinstaller --onefile textlands_cli/main.py

License

MIT

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

textlands-0.1.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

textlands-0.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file textlands-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for textlands-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9242a696e436b5fdeeb41e7a8313cdf9f72cd8f2bc28ff7f13ac48d78f56f54e
MD5 f166f59a44ba04dd55a0d859947d3856
BLAKE2b-256 1212582b2061c4ebf60da3868e94b2ad33a8d69a105b882edeb89840ceea5f3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for textlands-0.1.0.tar.gz:

Publisher: publish.yml on MindFortressInc/textlands-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 textlands-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for textlands-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b99ef91976c7e87c877387142f2112746c33d3b491585c928301c4a6a8136a54
MD5 cf593d3d8a95af4eff3bdbe5ff83c330
BLAKE2b-256 fb3c5a08f7becd88e191b2e82b5b72cd8ed4affb3888e1af397a82dc4358619a

See more details on using hashes here.

Provenance

The following attestation bundles were made for textlands-0.1.0-py3-none-any.whl:

Publisher: publish.yml on MindFortressInc/textlands-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