0.0.4 • Published 5 months ago

hypercode-cli v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

hypercode-cli

hypercode-cli is a command-line interface tool designed to interact with hypercode commands. It allows you to process various types of queries such as boolean, integer, string, datetime, and float evaluations right from your terminal.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed Node.js and npm.
  • You have a Hyper API key. To get one, sign up for a Hyper account and generate an API key in your settings.

Installation

To install hypercode-cli, follow these steps:

npm install -g hypercode-cli

Configuration

To configure the CLI with your API key, create a .env file in the root directory of the hypercode-cli and add the following:

HYPER_API_KEY=your_api_key_here

Make sure to replace your_api_key_here with your actual Hypercode API key. You can generate an API key in your Hyper API key settings.

Usage

To use hypercode-cli, run the following command in your terminal:

hypercode-cli

You will be prompted with > where you can enter your commands.

Here are some command formats you can use:

boolean("query")
integer("query")
string("query")
datetime("query")
float("query")

Alternatively, you can prefix commands with hyper.:

hyper.boolean("query")
hyper.integer("query")
hyper.string("query")
hyper.datetime("query")
hyper.float("query")

To exit the CLI, type exit.

Example

Here's an example session with hypercode-cli:

hypercode-cli
> boolean("Is the sky blue?")
true
> integer("How many continents are there?")
7
> exit
Exiting hypercode CLI...