OpenFn / OpenFn/kit

CLI init command

Open
#1,058 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the openfn init CLI entry point and review the expected project artifacts: openfn.yaml, claude.md, the gitignore, and .project rules. Done means the command creates the requested defaults, handles existing files as described, and optionally prompts for the proposed project settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, typescript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.