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.5.tar.gz (12.0 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.5-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for railtracks_cli-1.1.5.tar.gz
Algorithm Hash digest
SHA256 4b1ac056c7ebf5ae056eea37c685ff8bed7bc9785ed7139f5ec2e5ca7db1f521
MD5 0e6b9981f829df296fc27f2adfb8f437
BLAKE2b-256 262f577dc160cc11df09e9a30007c107aac974144b32c4f02fc3ca0d2e4957b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for railtracks_cli-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 780edeac402516676061f11ad06412573f69ba9ba85f6e214cf5216236d0b494
MD5 2eb269a4ba881c032f8837c2e5252deb
BLAKE2b-256 7715bfe76937f97162e1ef50a38e926f4aa2ec2564070610b66adffde73691ca

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