npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

adr-tool

v0.3.0

Published

easy CLI for ADR docs

Downloads

1,169

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

keremciukeremciu

Keywords

oclif

Readme

adr-tool

easy CLI for ADR docs

oclif Version Downloads/week License

Demo

Usage

You can install it globally (npm install -g adr-tool) or use it with npx

$ npx adr-tool init
./docs/adr folder is created!
$ npx adr-tool create Use Markdown Architectural Decision Records
a decision created on ./docs/adr/0000-use-markdown-architectural-decision-records.md

Commands

adr-tool create [TITLE]

create a new decision and log it into docs/adr/README.md file

USAGE
  $ adr-tool create [TITLE]

ARGUMENTS
  TITLE  title of the decision

OPTIONS
  -h, --help                               show CLI help
  -t, --ticket=ticket                      technical ticket
  --status=accepted|deprecated|superseded

EXAMPLE
  $ adr-tool create Use ADR Tool
  a decision created on ./docs/adr/0000-use-adr-tool.md

See code: src/commands/create.ts

adr-tool help [COMMAND]

Display help for adr-tool.

USAGE
  $ adr-tool help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

OPTIONS
  -n, --nested-commands  Include all nested commands in the output.

See code: @oclif/plugin-help

adr-tool init

create docs/adr folder and copies template.md and README.md

USAGE
  $ adr-tool init

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ adr-tool init
  ./docs/adr folder is created!

See code: src/commands/init.ts

adr-tool toc

create docs/adr/README.md file

USAGE
  $ adr-tool toc

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ adr-tool toc
  ./docs/adr/README.md file is created!

See code: src/commands/toc.ts