Skip to content
This repository has been archived by the owner on Jan 27, 2022. It is now read-only.
/ basha Public archive

🔨 Bash interpreter for executable documents

License

Notifications You must be signed in to change notification settings

stencila/basha

Repository files navigation

🔨 Basha

Bash executor for executable documents

Build Status Code coverage NPM Docs

⚠️ Deprecated

This project is deprecated and no longer maintained. At the time of writing, we are instead focussing on using a Bash "microkernel" or bash_kernel for execution of Bash code in Stencila. Please see, our main repository, stencila/stencila for further information.

📦 Install

Basha is available as a Node.js package,

npm install @stencila/basha --global

In the future, Basha is likely to be bundled as part of the self contained Stencila command line tool.

Windows is not yet supported.

🚀 Use

Register Basha so that it can be discovered by other executors on your machine,

basha register

If you have executa installed globally, you can then run Basha using the execute command and specifying bash as the starting language,

executa execute --repl --lang bash

🛠️ Develop

You can test Basha manually using the local install of executa in this package. First, build and register the current version of Basha, so that Executa is able to find it,

npm run register
npx executa execute --repl --lang bash