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.9.tar.gz (14.4 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.9-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for railtracks_cli-1.1.9.tar.gz
Algorithm Hash digest
SHA256 33939ef1e966e3eb146e2f3416e6379e9505dbcc9578e64f153536e651a53e52
MD5 97d9cd80bc996b2d304f3d42cc0ed944
BLAKE2b-256 0d8a1be7c2c1b788b0a3aa733f7a03e70ed1b427b2203a713f6c875c3fc1bf7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for railtracks_cli-1.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 3d8cfe825cd6cdb274b0c77dfd8b1916ea26d1e3c2b1f6edf198622ea98b3270
MD5 6883a8a55b58ce43bba9bfeb80fd283a
BLAKE2b-256 9f8efee459ebeabfdcca4853ae1f9996ce8281ceb682e70317c5ae7e3f5f6eb2

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