Getting Started

Installation

Litebase is a single binary available for Linux, macOS, and Windows that can be installed on your local machine or remote server.

  1. Install Litebase CLI

    To get started with Litebase, you can install it using the following command:

    shell
    curl -sL https://litebase.com/install.sh | sh

    Or, you can download the latest version from the Litebase GitHub repository.

  2. Configure Litebase

    After installation, you should configure Litebase to ensure it’s set up for your needs. You can do this by running:

    shell
    litebase config

    This command will walk you through the configuration process which entails selecting storage options and providing necessary details. For more detailed information about configuring Litebase, especially for production, refer to the configuration guide.

  3. Start Litebase Server

    shell
    litebase start

    Once started, Litebase will automatically create a directory in your home folder called ~/.litebase, which will contain configuration and data files.

Next Steps

Congratulations! You’ve successfully installed and started Litebase. You can now start using it to manage your projects and data.

Connecting to Litebase

To connect to the Litebase Server, you can use one of our supported SDKs.

We plan to provide support for more languages and frameworks soon!

CLI Reference

Once installed, you can use --help to see a list of available commands.

shell
litebase --help

For a full reference of the CLI commands, see the CLI documentation.

Previous Article
Next Article