guruprasadnpk / openline-cli

Openline command line interface

Openline command line interface (CLI)

The Openline CLI is an integral part of working with the Openline ecosystem.

_{Built with ❤︎ by the Openline community!}

👋 Overview

This guide will get you up and running with Openline in less than 5 minutes.

The Openline CLI is a NodeJS app that makes it easy to setup and manage Openline apps directly from the terminal. It's an essential part of using Openline. To develop on the Openline CLI, you'll need Node.js version 16.14 or above installed on your machine.

🚀 Installation

Download the Openline CLI using the following command

via brew

brew tap openline-ai/cli
brew install openline

via install script

curl http://openline.sh/install.sh | sh

You can check that the Openline CLI is properly installed by running

openline --version

If everything has been setup correctly, you'll see an output that looks like openline/x.y.z.

🧑‍💻 Working locally

Check out our Guide to Contributing Code for complete step-by-step instructions on how to get setup.

Quick Start

1. Clone the repo
2. cd into the repo directory
3. run yarn to install any missing dependencies
4. run yarn build to build the local codebase
5. run node ./bin/run to initiate the CLI

💡 Pro Tip: If you are going to contribute code to this repo, you'll save yourself a ton of time by aliasing the node ./bin/run command. We suggest adding the following to your .zshrc or .bashrc file.

alias ol="node {path/to/project/dir}/packages/cli/bin/run"

Once aliased, you'll be able to run your local codebase by typing ol {command}.

🤝 Resources

• Full reference docs for the CLI can be found via our CLI guide
• For help, feature requests, or chat with fellow Openline enthusiasts, check out our slack community!

💪 Contributions

• We love contributions big or small! Please check out our guide on how to get started.
• Not sure where to start? Book a free, no-pressure, no-commitment call with the team to discuss the best way to get involved.

✨ Contributors

A massive thank you goes out to all these wonderful people (emoji key):

🪪 License

• This repo is licensed under Apache 2.0, with the exception of the ee directory (if applicable).