Introduction
Courier is a development tool that allows you to write code locally and view the results instantly. Once you're satisfied with your work, you can push it to your Blutui project for review. Courier is designed to offer the best of both worlds by integrating local workflow with the cloud, thereby making development faster, more enjoyable, and more creative. This guide outlines the steps to install and set up Courier on a macOS machine.
Prerequisites
- Homebrew installed.
- Administrative access for local setup and cloud connectivity.
Installation
Add the Courier Homebrew Tap
Firstly, open your terminal and run the following command:
brew tap blutui/courier
Install Courier
Secondly, continue in your terminal with:
brew install courier
Courier will require administrative access for running projects locally and connecting to Blutui.
Verify the installation
Lastly, to confirm that Courier is successfully installed, run:
courier
This will display a list of available commands, confirming Courier is now successfully installed.
Additional steps for Firefox users
If you're using Firefox, you'll need to install Network Security Services (NSS):
Install NSS
brew install nss
Now you should be able to use courier dev
on Firefox.
Authentication
Before using Courier, you need to generate a Blutui access token. Follow these steps:
- In your Agency Console, click on your avatar in the top-right corner and choose
Edit my profile
. - Go to the
Apps
section in the sidebar. - Click
Create token
on the right, under the "Access tokens" section. - Name your token, e.g., "Work MacBook".
- Set the token type to "Courier". Required permissions for Courier will be automatically selected.
- Click Create token. Your Courier token will be displayed. Copy and store it securely, as it will only be shown this one time.
Using your Courier token
- To securely add your access token to a
token.txt
file, use the following command:
read -s -p "Enter your Courier access token: " TOKEN && echo $TOKEN > token.txt
This command prompts for the token input without displaying it on-screen, then saves it to token.txt
file without recording it in shell history.
- Log in to Courier using your token file:
courier login --token < token.txt
- Remember to delete the
token.txt
file once you have successfully logged into Courier.
Once configured, you're ready to start pushing and pulling projects.
Complete the getting started guide and learn how to start building your first project.
And there you have it—a complete guide to installing, and setting up Courier on macOS!
More resources
How do I pull a project onto my machine?
Learn how to pull your project from Blutui onto your machine for development.
How do I preview a project onto my machine?
Learn how to preview your project on your machine while in development.
How do I push a project to Blutui?
Learn how to push your project code from your machine to Blutui.