Categorygithub.com/tempestdx/cli
module
0.1.13
Repository: https://github.com/tempestdx/cli.git
Documentation: pkg.go.dev

# README

Tempest CLI

Go Reference Test Status

The official Tempest CLI client.

Requirements

  • Go 1.23 or later

Installation

You can install the Tempest CLI, scaffold an app locally, and display its configuration details in a few simple steps.

Install Using Homebrew

brew install tempestdx/tap/tempest

Install Using Go

go install github.com/tempestdx/cli/tempest@latest

Getting Started

# Create a directory and initialize your first Private App
mkdir tempest && cd tempest
tempest app init <name>

For more information on how to use the Tempest CLI, see our Quick Start guide.

Documentation

For documentation on all available commands, see our CLI documentation.

For details on all the functionality in this client, see our Go documentation.

Support

New features and bug fixes are released on the latest version of the Tempest CLI client. If you're using an older major version, we recommend updating to the latest version to access new features, benefit from recent bug fixes, and ensure you have the latest security patches. Older major versions of the client will continue to be available for use, but will not be receive any further updates.

Development

Pull requests from the community are welcome. If you submit one, please keep the following guidelines in mind:

  1. Code must be go fmt compliant.
  2. All types, structs and functions should be documented.
  3. Ensure that go test succeeds.

Test

The test suite needs testify's require package to run:

github.com/stretchr/testify/require

Before running any tests, make sure to grab all of the package's dependencies:

go get -t -v ./...

Run all tests:

go test -race -v ./...

Run tests for one package:

go test -v ./internal/...

Run a single test:

go test -v ./internal/... -run TestReadConfigSuccess

To share any requests, bugs or comments, please open an issue or submit a pull request.

# Packages

Copyright © 2024 NAME HERE <EMAIL ADDRESS> */.
No description provided by the author