0.2.1 • Published 3 months ago
@turbo-stoplight/server v0.2.1
@turbo-stoplight/server
Server component for Turbo Stoplight - a tool for managing persistent Turborepo pipelines.
Installation
# npm
npm install @turbo-stoplight/server --save-dev
# yarn
yarn add @turbo-stoplight/server --dev
# pnpm
pnpm add @turbo-stoplight/server -D
Overview
Turbo Stoplight is a lightweight CLI tool for managing persistent Turborepo pipelines in a monorepo. It starts a temporary TCP server when a Turbo task is not cached, acting as a stoplight indicator for build processes. The server remains active until it receives a signal via a socket connection, providing a reliable way to control builds, monitor pipeline status, and improve CI workflows.
Features
- Persistent pipeline management for Turborepo
- CI-friendly architecture
- Easy monitoring of pipeline status
- Optimized for monorepo workflows
Usage
# Start the server
npx turbo-stoplight-server --task_id build --port 5005
Configuration Options
The server can be configured with the following options:
npx turbo-stoplight-server --help
Requirements
- Node.js 16+
- Turborepo 2.4.4 or later
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit
) and follow the prompt - Push to the branch (git push origin feature/amazing-feature)
- Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.