OpenFn / OpenFn/kit

CLI: auto-create credentials.yaml

Open
#1,261 0 comments 0 reactions 1 assignee View on GitHub

@doc-han is already working on this.

Since Mar 24, 2026.

  • #1340 by @doc-han — merged
CLI DevX sync v2
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

Users can manually create a credentials.yaml file inside a project. They can enter key/value pairs under a credential id.

When running a workflow, the CLI will auto-load credential values from this file and feed them into each step, allowing a lightning workflow to execute locally.

But it's annoying for users to hand-build this file.

So when checking out a project, we should auto-populate the credentials.yaml file with whatever credentials are used by the project.

We need to ensure that for every credential id referenced in every workflow for the project, there is an empty value in credentials.yaml.

Do not override any user values. Do add new value if the workflow changed on pull.

Note that we don't need to set any credential values here - just put a stub entry in the file to make life easier for users.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.