wecli

wecli - Weaviate CLI in Golang

wecli is a command-line interface (CLI) client for Weaviate, built using the Golang Cobra framework. This tool aims to provide a seamless and user-friendly experience for managing various aspects of Weaviate instances directly from the terminal.

Table of Contents

• Clonning
• Getting Started
• Installation
• Commands
• Contributing
• License

Getting Started

To get started in wecli, you need to have Golang installed on your machine. Once you have installed Go, you can clone the application using the following command:

Installation

You can install the application in your local machine using the following command:

git install github.com/ibilalkayy/wecli@latest

Verify the installation through the following command:

wecli --version

This will display the installed wecli version.

Commands

wecli provides a variety of commands for managing Weaviate instances. Below are some key commands:

To use the application, simply run the wecli command followed by one of the following subcommands:

• connect: Makes a connection with WCS instance
• class: Creates a class in the schema
• schema: Builds a schema

Each subcommand has its own set of options and arguments. Here are some examples of how to use the application:

# Connect with the WCS instance
wecli connect --url wcs sandbox url --wapi wcs sandbox api key --oapi OpenAI api key

Clonning

1. Clone the repository:

   git clone https://github.com/ibilalkayy/wecli.git
   

2. Navigate to the project directory:

   cd wecli
   

3. Build and install the wecli binary:

   go install
   

Contributing

We welcome contributions! If you have ideas for new features, find a bug, or want to improve documentation, feel free to open an issue or submit a pull request. Please follow our Contribution Guidelines for a smooth collaboration.

License

wecli is licensed under the Apache-2.0 License. Feel free to use, modify, and distribute the code as per the license terms.