📽 Projector: The CLI for bootstrapping projects
Table of Contents
- About
- Commands
- Getting Started
- Contribution Guidelines
- Developer Guidelines
- Application Telemetry
- Maintainers
- License
- FAQ
About
projector is a tool that was created as an effort to reduce duplicated work in bootstrapping projects.
It aims to reduce friction, time and effort for developer teams in the following use cases:
- Discovering and consuming content from an engineering playbook, such as the Code-With Engineering Playbook.
- Creating templatized work items within Agile providers (e.g. Azure DevOps, Jira, GitHub). This can be used to create shared "checklists" of stories/features/tasks that should exist within every engagement and add them right to the developer team's backlog
- Creating a sprint schedule for the project within the Agile provider. Rather than clicking around Azure DevOps every week to create a new sprint, this is a one command execution that will generate as many sprints as required of the desired length and start date.
- Opening commonly used links in your playbook. Could be helpful when onboarding new engineers to a playbook.
- ...and more to come! We hope to receive feedback and ideas from engineers on what tasks they do most frequently to manage their projects and how we can automate them through the command line.
Commands
See the commands doc for usage and description of each command.
Getting Started
Projector runs on Node 14+.
To install the pjr CLI tool, run:
npm i pjr -gTo see how to accomplish the tasks above using pjr commands, follow the how-to documentation.
Contribution Guidelines
See our contribution guidelines doc for more info on how you can contribute to projector.
Developer Guidelines
See our local development documentation for things like installing, linting, building, testing and more.
Application Telemetry
Projector uses Application Insights to better understand and fix errors that come up in the CLI.
To opt out of this, set the environment variable TELEMETRY_ENABLED=0.
This can be done manually in whatever shell you're using or in the .projector.env file that is picked up by Projector.
Maintainers
For any questions about the project, please reach out to any one of the project maintainers:
License
FAQ
Here are some common problems and solutions to issues in projector.
Running pjr the first time fails
When running pjr for the first time, if you encounter an error like the following:
$ pjr
internal/modules/cjs/loader.js:638
throw err;
^
Error: Cannot find module 'fs/promises'Make sure you are running Node version 14+.
$ node --version
v14.x