Steps CLI

by Steps By AI

CLI to create Interaction Graphs of your entire application

---

Setup

1. Install Steps globally to use in any repository:

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

Usage

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

`sh
git add
steps
`

Features

$3

To specify the files to look for components and pages:

`sh


React components

`
The default filetypes set is tsx,jsx


$3

To specify the language used to generate commit messages:

`sh


de, German ,Deutsch

`ignorelang
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:

`sh
steps hook set
`

To unset the hook:

`sh
steps hook unset
`

To use the hook:

`sh
git add
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.