boxmetrics-cli

This repo contains the boxmetrics cli built with Go

✨ Features

This CLI aim to manage the whole boxmetrics ecosystem :

• Install agent locally or on multiple target
• Uninstall agent locally or on multiple target
• Get various data from API
• Generate report from boxmetrics API
• Test boxmetrics API heatlcheck
• Test boxmetrics frontapp heatlcheck

🚀 Quick start

1. From docker image :

docker run boxmetrics/boxmetrics-cli

2. From installation script :

curl https://raw.githubusercontent.com/boxmetrics/boxmetrics-cli/master/scripts/install.sh | bash

3. From prebuilt binary :

1. Donwload a binary from Github release page

2. Run application

# Made application executable
sudo chmod +x boxmetrics

# Run application
./boxmetrics --help

4. From source code :

1. Clone the git repository

# cloning git repository
git clone https://github.com/boxmetrics/boxmetrics-cli

2. Build application

# go to boxmetrics-cli directory
cd boxmetrics-cli
# run helper command to build
make build

3. Run application

# Made application executable
sudo chmod +x bin/boxmetrics

# run application
./bin/boxmetrics --help

💬 Contributing

1. Fork the git repository

2. Create your feature branch

3. Apply your changes

4. Run tests

# run test
make tests

make build
# test your feature
./bin/boxmetrics -awesome feature

6. Commit your changes

7. Push it on your fork

8. Create new pull request

🧐 What's inside ?

.
├── bin             # Project binaries
├── cmd             # Main applications for this project
├── configs         # Configuration file templates or default configs
├── docs            # Design and user documents
├── internal
│   └── pkg         # Private library code
├── scripts         # Scripts to perform various build, install, analysis, etc operations
├── test            # Additional external test apps and test data
├── Dockerfile      # Docker image
├── go.mod          # Module dependencies
├── go.sum          # Ensure dependencies integrity
├── JenkinsFile     # Jenkins pipeline
├── main.go         # Application entry point
├── Makefile        # Helpers command
├── LICENSE
└── README.md

👷 Maintained by

Project initially launched by Laurent Panek, Maxence Colmant and Abdessalam Benharira

Laurent Panek Security System Integrator

Abdessalam Benharira JavaScript Developer