Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/otterize/otterize-cli
CLI utility to interact with the open source network mapper and Otterize Cloud.
https://github.com/otterize/otterize-cli
hacktoberfest network-mapper network-visualization
Last synced: about 2 months ago
JSON representation
CLI utility to interact with the open source network mapper and Otterize Cloud.
- Host: GitHub
- URL: https://github.com/otterize/otterize-cli
- Owner: otterize
- License: apache-2.0
- Created: 2022-09-14T10:30:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T15:31:38.000Z (about 2 months ago)
- Last Synced: 2024-07-25T17:26:07.161Z (about 2 months ago)
- Topics: hacktoberfest, network-mapper, network-visualization
- Language: Go
- Homepage:
- Size: 1.47 MB
- Stars: 32
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Otterize CLI
[](https://joinslack.otterize.com)
[About](#about) | [Installation & usage with the network mapper](#installation-instructions--usage-with-the-network-mapper) | [Docs](https://docs.otterize.com/reference/cli) | [Contributing](#contributing) | [Slack](#slack)
## About
The Otterize CLI is a command-line utility used to control and interact with the [Otterize network mapper](https://github.com/otterize/network-mapper), manipulate local intents files, and interact with Otterize Cloud.
See the [CLI command reference](https://docs.otterize.com/reference/cli) for how to use it.
Example output from running the network mapper on the [Google Cloud microservices demo](https://github.com/GoogleCloudPlatform/microservices-demo):
```bash
$ otterize mapper list
cartservice in namespace ecommerce calls:
- redis-cart
checkoutservice in namespace ecommerce calls:
- kafka-secure
frontend in namespace ecommerce calls:
- adservice
- cartservice
- checkoutservice
- currencyservice
- productcatalogservice
- recommendationservice
- shippingservice
kafka-secure in namespace ecommerce calls:
- kafka-secure
- lab-zookeeper
paymentservice in namespace ecommerce calls:
- kafka-secure
recommendationservice in namespace ecommerce calls:
- productcatalogservice
```
## Installation instructions & usage with the network mapper
### Install the network mapper using Helm
```bash
helm repo add otterize https://helm.otterize.com
helm repo update
helm install network-mapper otterize/network-mapper -n otterize-system --create-namespace --wait
```
### Install Otterize CLI to query data from the network mapper
Mac
```bash
brew install otterize/otterize/otterize-cli
```
Linux 64-bit
```bash
wget https://get.otterize.com/otterize-cli/v1.0.5/otterize_linux_x86_64.tar.gz
tar xf otterize_linux_x86_64.tar.gz
sudo cp otterize /usr/local/bin
```
Windows
```bash
scoop bucket add otterize-cli https://github.com/otterize/scoop-otterize-cli
scoop update
scoop install otterize-cli
```
For more platforms, see [the installation guide](https://docs.otterize.com/installation#install-the-otterize-cli).
## Contributing
1. Feel free to fork and open a pull request! Include tests and document your code in [Godoc style](https://go.dev/blog/godoc)
2. In your pull request, please refer to an existing issue or open a new one.
3. See our [Contributor License Agreement](https://github.com/otterize/cla/).
## Slack
[Join the Otterize Slack!](https://joinslack.otterize.com)
## Usage Telemetry
The CLI reports anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.
To **disable** sending usage information:
- Using a flag: `--telemetry-enabled=false`.
- Via an environment variable: `OTTERIZE_TELEMETRY_ENABLED=false`.
If the `telemetry` flag is omitted or set to `true`, telemetry will be enabled: usage information will be reported.
Read more about it in the [Usage telemetry Documentation](https://docs.otterize.com/otterize-oss/usage-telemetry)