https://github.com/jgfranco17/infrasights
CLI tool that provides developers with essential information about their development environment
https://github.com/jgfranco17/infrasights
cli-app devops golang
Last synced: 3 months ago
JSON representation
CLI tool that provides developers with essential information about their development environment
- Host: GitHub
- URL: https://github.com/jgfranco17/infrasights
- Owner: jgfranco17
- Created: 2024-03-31T07:28:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T14:49:36.000Z (about 2 years ago)
- Last Synced: 2024-04-03T04:04:38.238Z (about 2 years ago)
- Topics: cli-app, devops, golang
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
InfraSights
---
## 🔎 About
The Infrasights CLI Tool is a command-line utility designed to provide developers with essential information about their development environment. It gathers various details such as Git status, Kubernetes configuration, Docker images, and more, helping developers streamline their workflows and troubleshoot issues effectively.
## 🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Before running the InfraSights CLI, make sure you have the following prerequisites installed:
**For usage**
- [Go 1.21](https://go.dev/doc/install) or higher
- [Git](https://git-scm.com/downloads)
- [Kubectl](https://kubernetes.io/docs/tasks/tools/)
- [Docker](https://docs.docker.com/engine/install/)
**For development (additional)**
- [Just](https://github.com/casey/just) command runner
### Installing
To get started with this project, clone the repository to your local machine and install the required dependencies.
```bash
git clone https://github.com/jgfranco17/infrasights.git
cd infrasights
just tidy
```
## 🚀 Usage
The tool will display information about your development environment, including Git status, Kubernetes configuration, Docker images, and more. Infrasights does not require any configuration. However, you can customize certain aspects by editing the source code or providing command-line arguments. Use the basic `help` to get an overview of commands available.
```shell
infrasights --help
```
## 🔧 Testing
### Running unittest suite
In order to run diagnostics and unittests, first install the testing dependencies. This will allow you to utilize the full capacity of the test modules we have built. To run the full test suite, run the Justfile command as follows:
```bash
just test
```
## ✒️ Authors
- [Chino Franco](https://github.com/jgfranco17)