Get Started

In this tutorial you will:

• play with your first cff flow

First, set up a project.

1. Start a new project

   mkdir hellocff
   cd hellocff
   git init
   go mod init example.com/hellocff
   

2. Install the cff CLI inside a bin/ subdirectory and make sure it doesn't get checked into version-control.

   GOBIN=$(pwd)/bin go install go.uber.org/cff/cmd/cff@latest
   echo '/bin' >> .gitignore
   

3. Create a new .go file with a go:generate directive to run cff.

   cat > gen.go <<EOF
   package main
   
   //go:generate bin/cff ./...
   EOF
   

Editor setup

You don't need a fully functional editor to try out cff. You can copy the provided snippets into your editor for this tutorial. However, if you would prefer to have a working editor even for the tutorial, take a detour to Editor configuration and come back here afterwards.

Now write your first flow.