View adr-cli on Snyk Open Source Advisor

Package Health Score

47 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version			Vulnerabilities	License Risk
1.2.3	\|	03/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	11/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.17	\|	11/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (25)

GitHub Stars: 0
Forks: 0
Contributors: 1

Direct Usage Popularity

The npm package adr-cli receives a total of 25 downloads a week. As such, we scored adr-cli popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package adr-cli, we found that it has been starred ? times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like adr-cli is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 10 months ago
Last Commit: 10 months ago

Further analysis of the maintenance status of adr-cli based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that adr-cli demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 11 Direct
Versions: 16
Install Size: 138 kB
Dist-tags: 1
# of Files: 38
Maintainers: 1
TS Typings: Yes

adr-cli has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Generar el registro de las deciciones de arquitectura (ADR).

Tablad de contenido

Instalacion

npm install -g adr-cli

For more information go to npmjs adr-cli.

Propiedades del CLI

Usage: adr-cli [options] [command]

Architecrture Decision Recored

Options:
  -v, --version          output the current version
  -h, --help             display help for command

Commands:
  new [title]            Create a new ADR file into document directory. Considering the relative directory in which it is located.
  index                  Create index file into document directory. Considering the relative directory in which it is located.
  show                   Show list of ADR files. For default is "doc/adr" in relative directory.
  init                   Initialize the working directory for the ADR`s
  status [options] [id]  Modify the status an ADR by id. The status chooice: proposed, acceptance, rejection, deprecation, superseding
  config                 Command to configure properties for the cli.
  help [command]         display help for command


    Example call config:
      $ adr-cli config get adrPath"
      $ adr-cli config set adrPath=""

New ADR

Command line:

 adr-cli new -h

Ooutput:

Usage: adr-cli new [options] [title]

Create a new ADR file into document directory. Considering the relative directory in which it is located.

Arguments:
  title       Name of title for ADR

Options:
  -h, --help  display help for command

Generate Index of ADR`s

 adr-cli index -h

Ooutput:

Usage: adr-cli index [options]

Create index file into document directory. Considering the relative directory in which it is located.

Options:
  -h, --help  display help for command

Show list of ADR files

 adr-cli show -h

Ooutput:

Usage: adr-cli show [options]

Show list of ADR files. For default is "doc/adr" in relative directory.

Options:
  -h, --help  display help for command

Init work directory

Usage: adr-cli init

Initialize the working directory for the ADR`s

Options: -h, --help display help for command

Show and modify status of ADR

 adr-cli status -h

Ooutput:

Usage: adr-cli status [options] [id]

Modify the status an ADR by id. The status chooice: proposed, acceptance, rejection, deprecation, superseding

Arguments:
  id                        Default "0 (default: "0")

Options:
  -s,--status   Set or change status for adr. The status chooice: proposed, acceptance, rejection, deprecation, superseding
  -h, --help                display help for command

Configure ADR relationship with other ADRs

adr-cli rel -h

Usage: adr-cli rel [options] [id]

Mark relation ADR to other/s ADR

Arguments:
  id                ADR source id (default: "0")

Options:
  -t,--to   ADR Id to add to source ADR. To add many Id`s, add separate by comma.
  -h, --help        display help for command

Show and modify config settings of adr-cli

 adr-cli config -h

Ooutput:

Usage: adr-cli config [options] [command]

Command to configure properties for the cli.

Options:
  -h, --help  display help for command

Commands:
  get   Command to get properties value.
  set   Command to set propertie value.
  path        Command to get the folder where is the config file for adr-tools.
  reset       Command to reset or regenerate the config file for defaults.
  show        Command to show key values of configurations. Properties si case sensitive

Ejemplo

Estados ADR

Los estados posibles son los siguientes:

Estado	Color
proposed	$\color{DodgerBlue}{proposed}$
acceptance	$\color{MediumSeaGreen}{acceptance}$
rejection	$\color{Tomato}{rejection}$
deprecation	$\color{Orange}{deprecation}$
superseding	$\color{Violet}{superseding}$

adr-cli dependencies

@types/n-readlines ajv chalk cli-table3 commander figlet inquirer listr markdown-table moment n-readlines

adr-cli development dependencies

@types/figlet @types/inquirer @types/node copyfiles typescript xo

FAQs

What is adr-cli?

Architecture Decision Records (ADR) command cli. Visit Snyk Advisor to see a full health score report for adr-cli, including popularity, security, maintenance & community analysis.

Is adr-cli popular?

The npm package adr-cli receives a total of 25 weekly downloads. As such, adr-cli popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is adr-cli well maintained?

We found indications that adr-cli is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is adr-cli safe to use?

While scanning the latest version of adr-cli, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 10 December-2024, at 02:35 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (25)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Tablad de contenido

Instalacion

Propiedades del CLI

New ADR

Command line:

Generate Index of ADR`s

Show list of ADR files

Init work directory

Show and modify status of ADR

Configure ADR relationship with other ADRs

Show and modify config settings of adr-cli

Ejemplo

Estados ADR

adr-cli dependencies

adr-cli development dependencies

FAQs

What is adr-cli?

Is adr-cli popular?

Is adr-cli well maintained?

Is adr-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues