Quick start
This guide will help you get started with the Floe in under 5 minutes.
Before you start
These docs assume you have completed onboarding through the Floe dashboard (opens in a new tab). You should also have generated an API key and have it ready.
Getting started
Install the CLI
The easiest way to get started with Floe is with the Floe CLI. The CLI works with npm (opens in a new tab), yarn (opens in a new tab), pnpm (opens in a new tab), and bun (opens in a new tab).
The following command will install the CLI globally.
npm i -g @floe/cli
-g
flag and install the CLI locally to your project.Initialize Floe
Use the setup wizard to install the .floe
directory. You should run this in the root of your documentation repository.
floe init
.git
file.Copy environment variables
Copy into the root .env
file of your project with the following environment variables:
FLOE_API_WORKSPACE
: The slug for your Floe workspace. You can find this value in the URL for your workspace, such ashttps://app.floe.dev/<slug>
or on the Developers page where you created the API key.FLOW_API_SECRET
: The secret token of the API key that you created before you began. To create an API key, visit the Developers page in your Floe workspace.
.env
file to the .gitignore
file for the repository.FLOE_API_WORKSPACE="<WORKSPACE_SLUG>"
FLOE_API_SECRET="<secret_...>"
Try it out!
echo "I done gone and wrote some docs." > test-file.md && floe review files test-file.md && rm test-file.md
This command will create a sample file test-file.md
with some grammatical
issues. We then run Floe against it with floe review files test-file.md
, and
finally remove the file.