version

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2024 License: MIT Imports: 0 Imported by: 0

README

Gottem

Gottem is a multi-API CLI application that allows users to query different APIs using keyboard shortcuts.

Prerequisites

  • Go 1.22.1 or later

Building the Application

To build the application, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Utility-Gods/gottem.git
    cd gottem
    
  2. Build the application:

    go build -o gottem ./cmd/cli
    

    This will create an executable named gottem in your current directory.

Running the Application

After building, you can run the application using:

./gottem

On Windows, use:

gottem.exe

Usage

Once the application is running:

  1. You will see a list of available APIs and their shortcuts.
  2. Enter your query in the format: <API_SHORTCUT> <QUERY>
  3. To exit the application, type exit

Example:

> 1 hello world
Response from Mock API 1: HELLO WORLD

Development

Adding a New API

To add a new API:

  1. Create a new file in internal/api/ (e.g., newapi.go) with your API implementation.
  2. Add the new API to the GetAPIHandlers() function in internal/api/handler.go.
Running Tests

To run tests:

go test ./...

License

[Add your license information here]

Contributing

[Add contribution guidelines here]

Contact

[Add contact information or links to issue trackers here]

Documentation

Index

Constants

View Source
const Version = "1.2.0"

Version holds the current version of the Gottem application. This is typically updated manually or by a build script before a new release.

Variables

This section is empty.

Functions

func VersionInfo

func VersionInfo() string

VersionInfo returns a string with the current version information.

Types

This section is empty.

Directories

Path Synopsis
cmd
cli command
internal
api
app
cli
db
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL