LiveChat Developer Console CLI

This project unlocks LiveChat Developer Console capabilities in the form of easy to use CLI application. Additionally, it allows for quick application bootstrap and project scaffolding.

📦 Installation

Use the npm or yarn package managers to install the developer-cli package in your project.

npm install -g @livechat/developer-cli
# or
yarn global add @livechat/developer-cli

🚀 Usage

LiveChat Developer Console CLI

lcdev [command]

Commands:
  lcdev init [dirName]  scafold new LiveChat app project from template
  lcdev open            open Developer Console application
  lcdev login           login with your LiveChat account

Options:
  --help     Show help
  --version  Show version number

⚙️ Getting started

Below you'll find a step by step guide how to go from a brand new LiveChat Developer Program account to a fully working LiveChat application ready to be used on your LiveChat account.

Warning Before you start make sure to already have a LiveChat account (you can create one here). You will also need Ngrok together with its free account installed on your computer to obtain a temporary and secure public domain for your local application (follow these instructions).

Install the LiveChat Developer Console CLI:

npm install -g @livechat/developer-cli

Verify that you are using the latest version and can access the CLI:

lcdev --version

lcdev login

Initialize a new project from our official Next.js app template:

lcdev init first-livechat-app

Install project dependencies and start local dev server:

cd first-livechat-app
npm install
npm run dev

Open the HTTP tunnel to obtain secure public domain for your local app:

ngrok http 3000

Bootstrap your new LiveChat app by providing the newly established public domain:

lcdev bootstrap --baseURL <your-https-domain-from-ngrok>

🏗 Contributing

Read the Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

This project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

📃 License

The code and documentation in this project are released under the MIT License.

Text Platform: who are we?

Behind Text, there’s a team of passionate people building online customer service software with online chat, help desk software, chatbot, and web analytics capabilities.

With a suite of five products (LiveChat, ChatBot, HelpDesk, KnowledgeBase, and OpenWidget) and their powerful APIs, we power customer communication for 36,000 companies in 150 countries.

The Platform is a range of products and services that can be used to build a variety of communication tools for businesses. Our Developer Program and Marketplace create an open ecosystem for developers, partners, and customers. With our advanced APIs and comprehensive documentation, you can shape the future of communication with us — starting today.

Join our Discord to learn, get inspired, and meet other developers!

livechat / developer-cli