![\"Logo\"](\"assets/logo.png\"){kind=logo}
\n \n
\n A task runner for JavaScript. Transform functions into CLI commands.\n
\n\n> *Named after **banosh**, a traditional Ukrainian dish from cornmeal cooked with various ingredients*\n\n---\n\n## Quick Example\n\n```js\n// Bunoshfile.js — run with: bunosh deploy\nexport async function deploy(env = 'production') {\n await exec`npm run build`.env({ NODE_ENV: env });\n await exec`rsync -az dist/ server:/var/www/`;\n say(`Deployed to ${env}`);\n}\n```\n\n## Installation\n\n### Single Executable (Recommended)\n\nDownload the standalone executable — no Node.js or Bun required:\n\n**macOS:**\n```bash\ncurl -fsSL https://github.com/davertmik/bunosh/releases/latest/download/bunosh-darwin-arm64.tar.gz | tar -xz\nsudo mv bunosh-darwin-arm64 /usr/local/bin/bunosh\n```\n\n**Linux:**\n```bash\ncurl -fsSL https://github.com/davertmik/bunosh/releases/latest/download/bunosh-linux-x64.tar.gz | tar -xz\nsudo mv bunosh-linux-x64 /usr/local/bin/bunosh\n```\n\n**Windows (PowerShell):**\n```powershell\nInvoke-WebRequest -Uri \"https://github.com/davertmik/bunosh/releases/latest/download/bunosh-windows-x64.exe.zip\" -OutFile \"bunosh.zip\"\nExpand-Archive -Path \"bunosh.zip\" -DestinationPath .\nMove-Item \"bunosh-windows-x64.exe\" \"bunosh.exe\"\n```\n\n### Package Managers\n\n```bash\n# Using Bun\nbun add -g bunosh\n\n# Using npm\nnpm install -g bunosh\n```\n\n## Quickstart\n\n1. **Initialize your Bunoshfile:**\n```bash\nbunosh init\n```\n\n2. **Write a command:**\n```javascript\n// Bunoshfile.js\nconst { exec, say } = global.bunosh;\n\n/**\n * Builds the project for production\n */\nexport async function build(env = 'production') {\n await exec`npm run build`.env({ NODE_ENV: env });\n say('Build complete');\n}\n```\n\n3. **Run it:**\n```bash\nbunosh build\nbunosh build staging\n```\n\n## Commands\n\nBy default, Bunosh loads commands from `Bunoshfile.js` in the current directory.\n\n```\nbunosh hello\n```\n\nYou can specify a custom file using `--bunoshfile` or the `BUNOSHFILE` environment variable:\n\n```bash\nbunosh --bunoshfile Bunoshfile.dev.js hello\nBUNOSHFILE=Bunoshfile.prod.js bunosh deploy\n```\n\n### Creating Commands\n\nEvery exported function in `Bunoshfile.js` becomes a CLI command:\n\n```javascript\nexport function hello() {\n console.log('Hello, World!');\n}\n\nexport function greet(name = 'friend') {\n console.log(`Hello, ${name}!`);\n}\n\nexport function deploy(env = 'staging', options = { force: false, verbose: false }) {\n if (options.verbose) console.log('Verbose mode enabled');\n console.log(`Deploying to ${env}${options.force ? ' (forced)' : ''}`);\n}\n```\n\n```bash\nbunosh hello\nbunosh greet John\nbunosh deploy production --force --verbose\n```\n\n### Arguments and Options\n\nBunosh maps function parameters to CLI arguments automatically:\n\n```javascript\n/**\n * Create a new feature branch\n * @param {string} name - Feature name (required)\n * @param {string} base - Base branch (optional, defaults to 'main')\n * @param {object} options - CLI options\n * @param {boolean} options.push - Push to remote after creation\n */\nexport async function feature(name, base = 'main', options = { push: false }) {\n await exec`git checkout -b feature/${name} ${base}`;\n\n if (options.push) {\n await exec`git push -u origin feature/${name}`;\n }\n}\n```\n\n```bash\nbunosh feature my-feature # Creates from main\nbunosh feature my-feature develop # Creates from develop\nbunosh feature my-feature --push # Creates and pushes\n```\n\n### Command Naming\n\nFunctions are automatically converted to kebab-case commands:\n\n| Function Name | CLI Command |\n|--------------|-------------|\n| `build` | `bunosh build` |\n| `gitPush` | `bunosh git:push` |\n| `npmInstall` | `bunosh npm:install` |\n| `buildAndDeploy` | `bunosh build:and-deploy` |\n\n### Project Namespaces\n\nOrganize tasks by creating multiple Bunoshfiles. Files named `Bunoshfile.