https://github.com/pzi/snyk-cheatset
A Dash cheat sheet for Snyk CLI.
https://github.com/pzi/snyk-cheatset
cheat-sheet cheatset cheatsheet dash docset snyk
Last synced: 11 months ago
JSON representation
A Dash cheat sheet for Snyk CLI.
- Host: GitHub
- URL: https://github.com/pzi/snyk-cheatset
- Owner: pzi
- License: unlicense
- Created: 2021-02-26T16:14:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-26T16:59:16.000Z (over 5 years ago)
- Last Synced: 2025-04-09T06:41:40.767Z (about 1 year ago)
- Topics: cheat-sheet, cheatset, cheatsheet, dash, docset, snyk
- Language: Ruby
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Snyk Cheatset
Snyk cheat sheet as docset for [Dash](http://kapeli.com/dash).
The cheat sheet is based on the
[Snyk CLI Cheatsheet](https://snyk.io/blog/snyk-cli-cheat-sheet/) on the [Snyk Blog](https://snyk.io/blog) and has been extended with content form the Snyk CLI help.
## Convert the cheatset to a docset
```bash
cheatset generate Snyk.rb
```
The [format](https://github.com/Kapeli/cheatset#readmehttps://github.com/Kapeli/cheatset#readme) used to define a cheat sheet is quite simple.
## Contributing
1. Fork this repository
1. Install cheatset: `$ sudo gem install cheatset`
**Note:** this requires the Xcode Command Line Tools to be installed.
`$ xcode-select --install`
2. Create a branch: `$ git checkout -b my-changes`
3. Generate docset: `$ cheatset generate Snyk.rb`
4. Test the docset in Dash
5. Commit & push your changes
6. Create new Pull Request