Repository navigation
CLI init command #1058
Description
User runs openfn init to init a new project
- Creates an openfn.yaml with defaults
- Creates a claude.md file cloned from
https://github.com/OpenFn/project - Creates a gitignore to support our standard patterns (like
tmp, credential file) - Maybe setup git rules for project sync (ie, when merging, never merge stuff in the .project folder)
The simple version of this just does the thing
A more complex version prompts users and asks what they want. Generate claude.md? y/n. If you run it multiple times it'll just ask you for the things that don't exist.
Maybe if there's no connected app project, it can prompt for a uuid or name
Activity
mtuchi commentedon Oct 20, 2025
Project template
https://github.com/OpenFn/project
josephjclark commentedon Dec 20, 2025
The init command can be re-run any time, and it should prompt for steps, like:
-Do you want to create/update a gitignore? It'll then add ignore rules one at a time, if they don't exist
-Do you want to create/reset openfn.yaml? It'll create a new one or reset the existing one to defaults
-Do you want to add claude.md? What this really does is create as job writing guide.md, and updates claude.md to reference it
josephjclark commentedon Mar 17, 2026
@theroinaochieng @brandonjackson I wanna bump up the priority of this so that we can get new projects off to a better start.
The ability to initialise a local project with the right files in the right places, plus some pre-configured claude code stuff, could be really really helpful to users.
Once we get it working in the CLI, we should consider adding it to the GitHub sync story too. Rather than just syncing the workflow files to a github repo, we should provide the option to intitialise the repo into an optimal structure
[-]sandbox: create a CLI init[/-][+]CLI init commmad[/+][-]CLI init commmad[/-][+]CLI init command[/+]