diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 0fbabdf..cf8ddc6 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -37,7 +37,7 @@ changelog: homebrew_casks: - repository: owner: scoutapp - name: homebrew-scout-cli + name: homebrew-tap token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" name: scout-cli binaries: diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3ab15b0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Zimuth, Inc. DBA Scout Monitoring + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 8041a07..b64bd5d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ # Scout APM CLI -A command-line interface for [Scout APM](https://scoutapm.com). View apps, metrics, endpoints, traces, errors, and insights from the terminal. +A command-line interface for [Scout Monitoring](https://scoutapm.com). Explore metrics, endpoints, traces, errors, and insights from the terminal. Built in Go with [Cobra](https://github.com/spf13/cobra), [Lipgloss](https://github.com/charmbracelet/lipgloss), [BubbleTea](https://github.com/charmbracelet/bubbletea), and [asciigraph](https://github.com/guptarohit/asciigraph). ## Install +### Homebrew + ```bash -go install github.com/scoutapm/scout-cli@latest +brew install scoutapp/tap/scout-cli ``` -Or build from source: +### Download binary + +Pre-built binaries for macOS, Linux, and Windows are available on the [GitHub Releases](https://github.com/scoutapp/scout-cli/releases) page. + +### Build from source ```bash -git clone https://github.com/scoutapm/scout-cli.git +git clone https://github.com/scoutapp/scout-cli.git cd scout-cli go build -o scout . ``` @@ -21,10 +27,7 @@ go build -o scout . ## Authentication ```bash -# Interactive login (prompts for API key) -scout auth login - -# Non-interactive +# Login scout auth login --key YOUR_API_KEY # Check auth status @@ -129,3 +132,9 @@ scout completion bash # Bash scout completion zsh # Zsh scout completion fish # Fish ``` + +## Links + +- [Scout Monitoring](https://scoutapm.com) — Application performance monitoring +- [Documentation](https://scoutapm.com/docs) +- [GitHub Releases](https://github.com/scoutapp/scout-cli/releases)