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.6.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.6-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: railtracks_cli-1.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 fac9d64eec9daaea0b3050c341ac5e238c477de30e30591cba107b1b4bc9f8ff
MD5 b2cadd5809b172a8a6dc7b1ec57840f3
BLAKE2b-256 5dceb35a71d52dd6512a6d8aeb27e85e32c570aa5428edd713696157b410c028

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for railtracks_cli-1.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 50cd3b01c186d8de9a18ecb48967fe9e4d8c3cf15a6fcc7ff6ccf59875d6afb4
MD5 f5d33fa8ab0527be20b36d168837dc2b
BLAKE2b-256 4679a70738d86725876293c52cf157397749d01a9d94ae8109a53998e2fb7511

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