Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.
/ cli Public archive

[DEPRECATED] ✨ Observability designed for distributed systems, microservices, serverless apps, and everything in between

License

Notifications You must be signed in to change notification settings

baselime/cli

Repository files navigation

Baselime CLI

Documentation Latest Release License

Baselime - Developer-First Observability for Serverless

The Baselime command-line application is a fast and straightforward tool for interacting with Baselime.


Table of Contents

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

Introduction

The official command line client for Baselime. Baselime CLI brings the power of Baselime and Observability as Code to the command-line.

Documentation is available on the Baselime Docs.

Goal

The Goal of the Baselime CLI is to provide a simple interface to interact with your Baselime applications and deploy your Observability as Code configurations.

Installation

Installing the CLI globally provides access to the Baselime command.

Install manually

curl -s https://get.baselime.io | bash

Install using Homebrew [Coming Soon]

brew tap baselime/tap
brew install baselime

To update:

brew upgrade baselime

Install using npm

$ npm install @baselime/cli -g

Download the compiled binary manually

Binary releases are available on GitHub Releases.

Validate installation

In all cases the installation can be validated by running baselime -v in the terminal:

0.0.2

Usage

baselime <command>
baselime <command> <subcommand> [flags]

Configuration

The configuration files are located in ~/.config/baselime. Each profile is saved in a file named against the profile. The default profile is saved in ~/.config/baselime/default.json. Configuration values can also be set using flags.

Troubleshooting

If unexpected errors occur when using baselime, make sure your environment is clean of any BASELIME_ 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 Baselime to start observing your serverless applications, visit the Baselime documentation.

For full command reference, see the list below, or visit docs.baselime.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.

License

© Baselime Limited, 2022

Distributed under MIT License (The MIT License).

See LICENSE for more information.