lstn

module
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2023 License: Apache-2.0

README

lstn

lstn is the listen.dev command line.

It lets you analyze the behavior of your dependencies.

TODO: image or asciinema

Documentation

For installation options see below, for usage instructions see the manual.

Installation

CI
GitHub Actions

We recommend using TODO: our GitHub Action for running lstn in CI for GitHub projects.

Other CI

It's highly recommended installing a specific version of lstn available on the releases page.

Here are a few ways to install it:

# 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:

lstn version
Locally

Wanna install lstn on your machine?

See options below.

Binaries
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 the releases page.

Linux & BSD

lstn is available via:

  • TODO: our Debian and RPM repositories
  • OS-agnostic package managers such as TODO: Homebrew, ...
  • our releases pages 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?
  1. Some users use the -u flag for go get which upgrades our dependencies: we can not guarantee they work!
  2. The go.mod replacement directive doesn't apply.
  3. The lstn stability may depend on a user's Go version.
  4. It allows installation from the main branch which can't be considered stable.
  5. 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.

There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.

Directories

Path Synopsis
cmd
in
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
lstn
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
root
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
scan
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
to
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
version
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
internal
docs
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
project
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
testing
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
pkg
cmd
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
cmd/arguments
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
cmd/flags
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
cmd/flagusages
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
cmd/groups
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
cmd/help
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
cmd/options
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
context
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
git
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
jq
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
listen
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
npm
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
os
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
text
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
transform
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
ua
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
validate
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
version
SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL