Skip to main content

railtracks - A Python development server with file watching and JSON API

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Railtracks CLI

PyPI version Python Versions License PyPI - Downloads Docs GitHub stars Discord

A simple CLI to help developers visualize and debug their agents.

What is Railtracks CLI?

Railtracks CLI is a development tool that provides:

  • Local Development Server: A web-based visualizer for your railtracks projects
  • File Watching: Automatic detection of JSON file changes in your project
  • JSON API: RESTful endpoints to interact with your project data
  • Modern UI: A downloadable frontend interface for project visualization

Quick Start

1. Installation

pip install railtracks-cli

2. Initialize Your Project

First, initialize the railtracks environment in your project directory:

railtracks init

This command will:

  • Create a .railtracks directory in your project
  • Add .railtracks to your .gitignore file
  • Download and extract the latest frontend UI

3. Start the Development Server

railtracks viz

This starts the development server at http://localhost:3030 with:

  • File watching for JSON changes
  • API endpoints for data access
  • Portable Web-based visualizer interface that can be opened in any web environment (web, mobile, vs extension, chrome extension, etc)

Project Structure

After initialization, your project will have this structure:

your-project/
├── .railtracks/          # Railtracks working directory
│   ├── ui/              # Frontend interface files
│   └── *.json           # Your project JSON files
├── .gitignore           # Updated to exclude .railtracks
└── your-source-files/   # Your actual project files

File Watching

The CLI automatically watches the .railtracks directory for JSON file changes:

  • Real-time Detection: Monitors file modifications with debouncing
  • JSON Validation: Validates JSON syntax when files are accessed
  • Console Logging: Reports file changes in the terminal

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

railtracks_cli-1.1.8.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

railtracks_cli-1.1.8-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file railtracks_cli-1.1.8.tar.gz.

File metadata

  • Download URL: railtracks_cli-1.1.8.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.5

File hashes

Hashes for railtracks_cli-1.1.8.tar.gz
Algorithm Hash digest
SHA256 e8da7e84ae8943cb844faab8176c1f3489cce1f9054020941c46c8ac0bb42c85
MD5 b8e61b2d9b6f5b1f968adaa4529dcd84
BLAKE2b-256 cbbc79e6ca30f17d37c3fe4a40497195462d846c2bf972e1197f7367f9b55175

See more details on using hashes here.

File details

Details for the file railtracks_cli-1.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for railtracks_cli-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5b537b709273a3cb776bbd1fbf29d36af40d8536b497d59d8526bbabe5873238
MD5 0d2eb01da6cf3a967e50ec124a13134f
BLAKE2b-256 f846ab4e1151304eda9bf01f7cf63c33496bcda89cbc4a9a2e725e41307f8849

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