@khulnasoft/kengine-cli
v0.0.80
Published
[![Documentation][docs_badge]][docs] [![Latest Release][release_badge]][release] [![License][license_badge]][license]<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> [![All Contributors](https://img.shields.io/badge/all_contrib
Downloads
3
Readme
KEngine CLI
🛠️ The Developer Toolset for the Serverless World
- 📊 Observability in your terminal: tail your logs and view your traces in your terminal (and finally close your CloudWatch browser tabs)
- 🪄 Observability as Code: manage your queries, alerts, slos, and more all as code
- 🧭 Works with any IaC, from the Serverless Framework to SST
Table of Contents
Introduction
The official command line client for kengine. Kengine CLI brings the power of Kengine and Observability as Code to the command-line.
Documentation is available on the Kengine Docs.
Goal
The Goal of the Kengine CLI is to provide a simple interface to interact with your Kengine applications and deploy your Observability as Code configurations.
Installation
Installing the CLI globally provides access to the Kengine command.
Install manually
curl -s https://https://raw.githubusercontent.com/khulnasoft/kengine-cli/install | bash
Install using Homebrew
brew tap kengine/tap
brew install kengine
To update:
brew upgrade kengine
Install using npm
$ npm install @khulnasoft/kengine-cli -g
Download the compiled binary manually
Binary releases are available on GitHub Releases.
Docker
Binary is also distributed as a docker image
Validate installation
In all cases the installation can be validated by running kengine -v
in the
terminal:
0.0.78
Usage
kengine <command>
kengine <command> <subcommand> [flags]
Configuration
The configuration files are located in ~/.config/kengine
. Each profile is saved in a file named against the profile.
The default profile is saved in ~/.config/kengine/default.json
.
Configuration values can also be set using flags.
Troubleshooting
If unexpected errors occur when using kengine
,
make sure your environment is clean of any KENGINE_
prefixed variables.
Use the --debug
flag to print in the console the stack trace of any error you encounter.
Documentation
To learn how to use Kengine to start observing your serverless applications, visit the Kengine documentation.
For full command reference, see the list below, or visit docs.khulnasoft.com.
Contributing
Feel free to submit PRs or to fill issues. Every kind of help is appreciated.
Kindly check our Contributing guide on how to propose bugfixes and improvements, and submitting pull requests to the project.
Contributors ✨
This project follows the all-contributors specification. Contributions of any kind welcome!
License
© KhulnaSoft Limited, 2023
Distributed under MIT License (The MIT License
).
See LICENSE for more information.