Table of documentation contents

Introduction to Weaviate-CLI

Index

Basics

  • The weaviate-cli tool is used work with individual weaviates or the weaviate cluster service.

Initiation

You can get an overview of available commands with the --help flag.

$ weaviate-cli --help

Overview of current commands:

usage: weaviate-cli [-h]
                    {init,schema-import,schema-export,schema-truncate,empty,cluster-create,cluster-remove,cluster-list,ping,version}
                    ...

CLI tool to interact with Weaviate instances. Mre information:
https://semi.technology/documentation/weaviate-cli

positional arguments:
  {init,schema-import,schema-export,schema-truncate,empty,cluster-create,cluster-remove,cluster-list,ping,version}
    init                Initiate a Weaviate. This function is used to connect
                        the CLI to a Weaviate instance
    schema-import       The schema file should be in the same format as
                        the/weaviate/v1/schema RESTful output
    schema-export       Save a copy of the Weaviate's schema to disk
    schema-truncate     Truncate the schema, the Weaviate must be empty.
    empty               Empty the Weaviate (i.e., all concepts will be
                        removed)
    cluster-create      Create a Weaviate cluster on the SeMI network
    cluster-remove      Delete a cluster
    cluster-list        List all clusters connected to configured email
    ping                Validate if a Weaviate can be pinged with or without
                        authentication
    version             Get the current version number
    upgrade             Upgrade the cli to the current version on Github

optional arguments:
  -h, --help            show this help message and exit

Frequently Asked Questions

If you can’t find the answer to your question here, please use the:

  1. Knowledge base of old issues. Or,
  2. For questions: Stackoverflow. Or,
  3. For issues: Github.
Tags
  • weaviate-cli
  • introduction