Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/listendev/lstn
A CLI tool to analyze the behavior of your dependencies using listen.dev
https://github.com/listendev/lstn
behavioral-analysis dependencies npm o11y security software-supply-chain-security
Last synced: 9 days ago
JSON representation
A CLI tool to analyze the behavior of your dependencies using listen.dev
- Host: GitHub
- URL: https://github.com/listendev/lstn
- Owner: listendev
- License: apache-2.0
- Created: 2022-11-10T10:17:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T17:19:31.000Z (16 days ago)
- Last Synced: 2024-12-24T17:32:46.569Z (16 days ago)
- Topics: behavioral-analysis, dependencies, npm, o11y, security, software-supply-chain-security
- Language: Go
- Homepage: https://listen.dev
- Size: 2.03 MB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# lstn
`lstn` is the [listen.dev](https://listen.dev) command line. It lets you analyze the behavior of your dependencies.
## Documentation
To install `lstn` in your environment, refer to the [installation](#installation) section below. For usage instructions, see:
- the [usage manual](docs/cheatsheet.md)
- the guide about the `~/.lstn.yaml` [config file](docs/configuration.md)
- the guide about the `LSTN_*` [environment variables](docs/environment.md)
- the [reporters reference](docs/reporters.md)
## Installation
### CI
#### GitHub Actions
We recommend using the [GitHub Action](https://github.com/listendev/action) for running `lstn` in CI for GitHub projects. For integration instructions see this [guide](https://docs.listen.dev/lstn-github-action/quick-start).
#### Other CI
It's highly recommended to install a specific version of `lstn` available on the [releases page](https://github.com/listendev/lstn/releases/latest). Here are a few ways to install it:
```bash
# The binary will be /usr/local/bin/lstn
curl -sSfL https://lstn.dev/get | sh -s -- -b /usr/local/bin
# Or install it into $PWD/bin/
curl -sSfL https://lstn.dev/get | sh -s
# In Alpine Linux (as it does not come with curl by default)
wget -O- -nv https://lstn.dev/get | sh -s
```
You can test the installation by running:
```bash
lstn version
```
### Locally
To install `lstn` locally, see the options below:
#### Binaries
```bash
curl -sSfL https://lstn.dev/get | sh -s -- -b /usr/local/bin
lstn version
```
#### macOS
`lstn` is available via TODO: Homebrew, ..., and as a downloadable binary from our [releases page](https://github.com/listendev/lstn/releases/latest).
#### Linux & BSD
`lstn` is available via:
- TODO: our Debian and RPM repositories
- OS-agnostic package managers such as TODO: Homebrew, ...
- our [releases pages](https://github.com/listendev/lstn/releases/latest) as precompiled binaries.
#### From source
We recommend using binary installation. Using `go install` or `go get` might work but those aren't guaranteed to.
Why?
- Some users use the
-u flag for go get which upgrades our dependencies: we can not guarantee they work!
- The
go.mod replacement directive doesn't apply.
- The
lstn stability may depend on a user's Go version.
- It allows installation from the main branch which can't be considered stable.
- It is way slower than binary installation.
## Contributing
If anything feels off, or if you feel that some functionality is missing, please check out the [contributing page](.github/CONTRIBUTING.md).
There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.