Blutui Courier
Note: Blutui Courier is currently in beta! We're working on more features to make the experience great.
courier
is a Blutui command-line interface to interact with your Blutui site(s). It allows you to easily push and pull code to and from your site.
Features
- Experince the power of Blutui from your local enviroment using
courier watch
, to easily keep your code in sync. - Easily push code to your site using the simple
courier push
command. - Get started with a new project using
courier pull
to easily pull the latest code from your site.
Getting Started
Installation
Note: Before getting started install Blutui Courier on your platform.
courier
is easy to install, works on macOS, Windows, and many popular Linux distributions.
Create an API key
Coming Soon.
Configure an existing site
Note: Please make sure you already have an existing site on Blutui before proceeding. Learn how to create a site.
After obtaining an API key its time to pull your first project. Open your preferred terminal and create a new directory, for this example we will create a new project
directory:
mkdir project
cd project
Inside the newly created project
, it's time to setup a new courier.json
configuration file, this config file is used by Blutui Courier to determine what project you are currently in. To create a new courier.json
file run:
courier init -H [your-site-handle] -s [your-site-url] -t [your-api-token]
For example:
courier init -H sonic -s sonic.blutui.com -t o03fs...
You should now have a brand new courier.json
configuration file. Now you can pull your site code from Blutui, this will allow you to build your site locally. To pull your site code from Blutui, run:
courier pull
You can run courier watch
to watch for file changes and automatically sync to with your Blutui site.
TIP: If you use git
we recommend adding .courier
directory to your .gitignore
file.