Setup

1. Install Steps globally to use in any repository:

   npm install -g @steps-by-ai/cli

Usage

You can call OpenCommit directly to generate a commit message for your staged changes:

git add <files...>
steps

Features

Filetype support

To specify the files to look for components and pages:

# React components
oc config set filetypes=tsx,jsx

The default filetypes set is tsx,jsx

Internationalization support

To specify the language used to generate commit messages:

# de, German ,Deutsch
oc config set language=de
oc config set language=German
oc config set language=Deutsch

# fr, French, française
oc config set language=fr
oc config set language=French
oc config set language=française

The default language set is English
All available languages are currently listed in the i18n folder

Ignore files

You can ignore files from submission to Steps By AI by creating a .stepsignore file. For example:

path/to/large-asset.zip
**/*.jpg

This is useful for preventing opencommit from uploading artifacts and large files.

By default, steps ignores files matching: out/**, dist/**, build/**, node_modules/**, *-lock.* and *.lock

Git hook

You can set OpenCommit as Git prepare-commit-msg hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.

To set the hook:

steps hook set

To unset the hook:

steps hook unset

To use the hook:

git add <files...>
git commit

Or follow the process of your IDE Source Control feature, when it calls git commit command — OpenCommit will integrate into the flow.

Acknowledgements

We would like to express our gratitude to the dev at OpenCommit for providing inspiration for the structure and design of the CLI for this project. We appreciate their dedication to open-source software and their commitment to making development more accessible and enjoyable for everyone.