{"id":50965547,"url":"https://github.com/microplan-xyz/microplan","last_synced_at":"2026-06-18T20:00:45.025Z","repository":{"id":57296700,"uuid":"73615726","full_name":"microplan-xyz/microplan","owner":"microplan-xyz","description":"Plan your project from command line","archived":false,"fork":false,"pushed_at":"2020-05-22T18:33:19.000Z","size":155,"stargazers_count":10,"open_issues_count":9,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-17T00:28:56.945Z","etag":null,"topics":["github","planning","project"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microplan-xyz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-13T12:53:17.000Z","updated_at":"2021-06-11T07:19:14.000Z","dependencies_parsed_at":"2022-09-01T13:01:46.365Z","dependency_job_id":null,"html_url":"https://github.com/microplan-xyz/microplan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/microplan-xyz/microplan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microplan-xyz%2Fmicroplan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microplan-xyz%2Fmicroplan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microplan-xyz%2Fmicroplan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microplan-xyz%2Fmicroplan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microplan-xyz","download_url":"https://codeload.github.com/microplan-xyz/microplan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microplan-xyz%2Fmicroplan/sbom","scorecard":{"id":643017,"data":{"date":"2025-08-11","repo":{"name":"github.com/microplan-xyz/microplan","commit":"48bbf1c04534c893adee628e08877a4788c8efff"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T11:20:29.228Z","repository_id":57296700,"created_at":"2025-08-21T11:20:29.228Z","updated_at":"2025-08-21T11:20:29.228Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34505422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","planning","project"],"created_at":"2026-06-18T20:00:43.230Z","updated_at":"2026-06-18T20:00:45.008Z","avatar_url":"https://github.com/microplan-xyz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"left\"\u003e\n  \u003cbr\u003e\n  \u003cimg width=\"300\" src=\"https://raw.githubusercontent.com/microplan-xyz/microplan/master/images/logo_black.png\" alt=\"microplan\"\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\nPlan your projects from the command line\n\n[![Build Status](https://semaphoreci.com/api/v1/scriptnull/microplan/branches/master/badge.svg)](https://semaphoreci.com/scriptnull/microplan)\n[![npm version](https://badge.fury.io/js/microplan.svg)](https://badge.fury.io/js/microplan)\n[![npm](https://img.shields.io/npm/dm/microplan.svg)](https://www.npmjs.com/package/microplan)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/microplan-xyz/microplan/blob/master/LICENSE)\n[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/microplan-xyz/Lobby)\n [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\n### Inspiration\n\u003e \"I am a strong believer that great software comes from great people. If you worry only about the technology side of the equation, you're missing way more than half of the picture\"\n\u003e\n\u003e -- Sam Newman (  \"Evolutionary Architect\", Building Microservices)\n\nWe want to solve the \"Planning\" side of the equation. And we want our tool to be handy. Talking of handy tools, the terminal comes to mind. So why not use that as our playground?\n\n### Installation\nMicroplan requires Node.js 0.12 or greater along with npm\n\n```bash\n$ npm install -g microplan\n```\n\n### Planning Tools\nThe following issue trackers/messaging tools are supported by microplan.\n\n| Tool | Status |\n|------|--------|\n| [Github](https://github.com/) | AVAILABLE   |\n| [Gitlab](https://gitlab.com/) | AVAILABLE   |\n| [Gitter](https://gitter.im)   | AVAILABLE   |\n\n### Getting Started\nLet's say you want to create a user registration form in your app. Your workflow might look something like this:\n\n- Ping the UX team on Slack/Gitter to ask how the UI should look like\n- Open an issue in the front-end repo (on GitHub) to add a page and notify about it (on Gitter)\n- Open another issue in the back-end repo (on GitLab ) to add an API endpoint\n\nWait. This seems all over the place! :O\n\nWhat if you had a consolidated solution baked right into your terminal?\n\nThis is where microplan comes into the picture! Let's get started and publish this plan to the specified tools from the cozy comfort of your command line.\n\n### Login\nUse the `login` command to store your credentials in the `.microplan` file in your HOME folder\n\n- Generate your GitHub `token` [here](https://github.com/settings/tokens)\n- Generate your GitLab `token` [here](https://gitlab.com/profile/personal_access_tokens)\n- Gitter uses a custom integration URL specified in the planning file (details to follow below)\n\n```bash\n$ microplan login\n```\n\n![anim](https://cloud.githubusercontent.com/assets/4211715/20641564/9cca34f2-b420-11e6-8155-8080fc33faa8.gif)\n\n### Initialize\n`init` creates a file to help you get started with the planning flow\n\n```bash\n$ microplan init [filename].yml\n\n$ microplan init --help\n\n  Usage: microplan-init [options]\n\n  Options:\n\n    -t, --template \u003clocation\u003e   specify input template location\n    -d, --directory \u003clocation\u003e  specify plan output directory\n    -h, --help                  output usage information\n\n```\n\nYep, that's it! Open filename.yml to configure.\n\n![anim](https://cloud.githubusercontent.com/assets/4211715/20641521/e8e06b5a-b41f-11e6-8dc3-9674c4fa4ca6.gif)\n\n### Configuration\nConfigurations lie at the heart of microplan and help you specify the platforms you want to publish to (eg. which repository to create an issue in or which room to plan the discussion in)\n\n```yml\nfeature: Create user registration form\ndescription: \"To persist user preferences ...\"\n\nconfiguration:\n  uxGitterChat:\n    type: gitter\n    url: \"https://webhooks.gitter.im/e/xxxxxxxxxxxxxxxxxxx\"\n\n  frontendRepo:\n    type: github\n    slug: \"microplan-xyz/www\"\n\n  backendRepo:\n    type: gitlab\n    slug: \"microplan-xyz/api\"\n```\n\n### Plans\nThe `plans` object is part of the same yml file and helps you express each step of your plan.\n\n```yml\nplans:\n  # Send a message to the UX team asking about the feature\n  - title: \"How should the User Registration Page look like?\"\n    description: \"Should it have a dark or light theme? And would you suggest a specific font we should use?\"\n    in: uxGitterChat\n\n  # Create an issue in the front-end GitHub repository\n  # And notify the UX team on Gitter\n  - title: \"Choose frontend css framework for user registration page\"\n    description: \"Should we go with Bootstrap or Spectre? Please let us know about the benchmark. Prototype PRs can be sent here.\"\n    assignee: scriptnull\n    in:\n      - frontendRepo\n      - uxGitterChat\n\n  # Create an issue with a lengthy description in the GitLab repository\n  - title: \"Support new user registration\"\n    in: backendRepo\n    assignee: scriptnull\n    description: \u003e\n      Add the `user-routes.js` file and use the Express router\n\n      ```javascript\n      var express = require('express')\n      var router = express.Router()\n\n      // GET /user\n      router.get('/user', function (req, res) {\n        // fetch from DB\n      })\n\n      router.post('/user', function (req, res) {\n        // save in DB\n      })\n\n      module.exports = router\n      ```\n```\n\n### Publishing\nOnce you have written the plan, use the `publish` command to create the issues and send messages to specified rooms\n\n```bash\n$ microplan publish [filename]\n\n$ microplan publish -h\n  Usage: microplan publish [options]\n\n  Options:\n\n    -h, --help      output usage information\n    -s, --serial    Publish plans serially\n    -p, --parallel  Publish plans parallely\n```\n![publish](https://cloud.githubusercontent.com/assets/4211715/20642219/225420f2-b42f-11e6-8966-153252c8c68a.gif)\n\n¡Eso es todo!\n\n* Your UX team will receive a Gitter notification\n\n![image](https://cloud.githubusercontent.com/assets/4211715/20642190/619ccb16-b42e-11e6-910e-976d54d0ec62.png)\n\n* the front-end issue will be created on GitHub\n\n![image](https://cloud.githubusercontent.com/assets/4211715/20642304/e58924a8-b431-11e6-97c4-cbff3d21a89d.png)\n\n* the back-end issue will be created on GitLab\n\n![image](https://cloud.githubusercontent.com/assets/4211715/20642197/7b463f84-b42e-11e6-88b6-06959a59d8f0.png)\n\n### Input Formats\nThe configuration file can be written in various formats.\n\n| Format | Status |\n|--------|--------|\n| YAML   | AVAILABLE |\n| JSON   | AVAILABLE |\n\n### Contributors\nAuthored and maintained by [@scriptnull](https://github.com/scriptnull) and [@argonlaser](https://github.com/argonlaser) with help from [contributors](http://github.com/microplan-xyz/microplan/contributors).\n\n### Attributions\nThanks to [these awesome npm packages](https://github.com/microplan-xyz/microplan/blob/master/package.json#L28-L42) without which the project would not have been possible.\n\n### Security\nPlease report any security vulnerabilities of this project to [keybase.io/scriptnull](https://keybase.io/scriptnull)\n\n```bash\n$ curl https://keybase.io/scriptnull/pgp_keys.asc | gpg --import\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroplan-xyz%2Fmicroplan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicroplan-xyz%2Fmicroplan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroplan-xyz%2Fmicroplan/lists"}