Skip to content

khulnasoft/kengine.js

Repository files navigation

Kengine CLI

npm Documentation Latest Release License All Contributors

Observability

🛠️ The Observability Toolset for the Cloud: observability in your terminal, tail your logs and view your traces in your terminal


Table of Contents

  1. Introduction
  2. Goal
  3. Installation
  4. Usage
  5. Documentation
  6. Contributing
  7. License

Introduction

The official command line client for Kengine.

Documentation is available on the Kengine Docs.

Goal

The Goal of the Kengine CLI is to provide a simple interface to interact with your telemetry data.

Installation

Installing the CLI globally provides access to the Kengine command.

Install manually

curl -s https://get.kengine.khulnasoft.com | bash

Install using Homebrew

brew tap kengine/tap
brew install kengine

To update:

brew upgrade kengine

Install using npm

$ npm install @khulnasoft/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.kengine.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 ✨

Boris Tane
Boris Tane

💻
Maksym Makuch
Maksym Makuch

💻
Thomas Ankcorn
Thomas Ankcorn

💻
Max Diamond
Max Diamond

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

© Kengine Limited, 2023

Distributed under MIT License (The MIT License).

See LICENSE for more information.