https://github.com/pgmanutd/node-talisman

👌 By hooking into the pre-push hook provided by Git, Talisman validates the outgoing changeset for things that look suspicious - such as authorization tokens and private keys.
https://github.com/pgmanutd/node-talisman

authorization authorization-tokens authorized-keys cli javascript node-talisman private-keys ssh-keys talisman thoughtworks typescript

Last synced: 3 months ago
JSON representation

👌 By hooking into the pre-push hook provided by Git, Talisman validates the outgoing changeset for things that look suspicious - such as authorization tokens and private keys.

• Host: GitHub
• URL: https://github.com/pgmanutd/node-talisman
• Owner: pgmanutd
• License: mit
• Created: 2019-04-06T20:39:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-25T01:05:53.000Z (11 months ago)
• Last Synced: 2024-08-20T12:48:42.232Z (4 months ago)
• Topics: authorization, authorization-tokens, authorized-keys, cli, javascript, node-talisman, private-keys, ssh-keys, talisman, thoughtworks, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/node-talisman
• Size: 4.2 MB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# node-talisman · [![npm](https://img.shields.io/npm/v/node-talisman.svg)](https://www.npmjs.com/package/node-talisman) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/pgmanutd/node-talisman/blob/master/LICENSE) [![CircleCI](https://circleci.com/gh/pgmanutd/node-talisman.svg?style=shield)](https://circleci.com/gh/pgmanutd/node-talisman) [![Coverage Status](https://coveralls.io/repos/github/pgmanutd/node-talisman/badge.svg?branch=master)](https://coveralls.io/github/pgmanutd/node-talisman?branch=master) [![Known Vulnerabilities](https://snyk.io/test/github/pgmanutd/node-talisman/badge.svg?targetFile=package.json)](https://snyk.io/test/github/pgmanutd/node-talisman?targetFile=package.json)

A npm package for running Thoughtwork's [Talisman](https://github.com/thoughtworks/talisman) tool as a CLI.

## Requires

- Node 12+

## Features

- Supports [Talisman v1.32.0](https://github.com/thoughtworks/talisman/releases/tag/v1.32.0).

- Linux, MacOS and Windows supported.

## Installation

1. Add package

   ```sh

   npm install --save-dev node-talisman

   ```

2. Add a script to package.json

   ```js

   {

     "scripts" : {

       "node-talisman": "node-talisman",

       ...

     }

     ...

   }

   ```

3. Use it as you like :wink:

   **Using above script:**

   ```sh

   npm run node-talisman -- --githook [pre-commit|pre-push]

   # finds all .js and .ts files in the current directory (recursively)

   npm run node-talisman -- --pattern="./**/*.{js,ts}"

   ```

   **Using npx:**

   ```sh

   npx node-talisman --githook [pre-commit|pre-push]

   # finds all .js and .ts files in the current directory (recursively)

   npx node-talisman --pattern="./**/*.{js,ts}"

   ```

   For more details checkout [Talisman as a CLI utility](https://github.com/thoughtworks/talisman#talisman-as-a-cli-utility).

## Contributing Guide

Anyone can help to make this project better - check out the [Contributing Guide](./.github/CONTRIBUTING.md)!

## Code of Conduct

Please adhere to [Code of Conduct](./.github/CODE_OF_CONDUCT.md).

## Issues

Please make sure to read the [Issue Reporting Guidelines](./.github/ISSUE_TEMPLATE.md) before opening an issue.

## Changelog

Detailed changes for each release are documented in the [release notes](https://github.com/pgmanutd/node-talisman/releases).

## License

Licensed under the [MIT licensed](./LICENSE).