Bashnode documentation

Welcome to Bashnode's official documentation center. Here you can learn about how Bashnode works behind the scenes and how to use Bashnode to its full potential.

If you have any questions or feedback regarding the documentation, feel free to let us know here.

---

What is Bashnode ?

Bashnode is an online CLI (Command line interface) builder. Using our web-based CLI builder tool, you can easily create your own custom CLI without writing any code.

CLIs are refered to as flows that contain nodes (actions, conditions, etc...). Creating a flow can be easily done in the dashboard here. Once you have created a flow, it can be executed using our NPX package.

npx (node package execute), as opposed to npm, is a built-in npm tool used to run npm packages without installing them localy. You can learn more about it here

How Bashnode works

After you have created a flow, you can instantly run it using the command

npx bashn@latest @<team>/<flow>

* Replace <team> by your team's handle and <flow> by your flow's install handle.

You can learn more about flow executions here.

You flow's nodes (actions, conditions, etc...) will then be interpreted one-by-one as a series of JavaScript tasks. If for some reason your flow is unable to run (example: copying a file that does not exist), the process will end with a status of 1 (error) and the remaining tasks will not be executed. Traces of the error will be available in the usage section of the dashboard.

Executing a flow, regardless of the final status, will register a usage.

System requirements

• Node JS version 18.0.0 or greater
• NPM