KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

babashka.el

★ 45 Open GitHub ↗

Babashka Tasks for Emacs

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# babashka.el
Emacs interface for [babashka](https://babashka.org) tasks.

[![MELPA](https://melpa.org/packages/babashka-badge.svg)](https://melpa.org/#/babashka)
[![MELPA Stable](https://stable.melpa.org/packages/babashka-badge.svg)](https://stable.melpa.org/#/babashka)

## Usage

### Simply call a task
The main entry point is `babashka-tasks`. If called from a buffer visiting a file in a project with `bb.edn` in it, it will look up the directory tree recursively until `bb.edn` is found, parses it for tasks and offer a menu to select a task to run:

![](https://raw.githubusercontent.com/licht1stein/babashka.el/master/videos/1-simple.gif)

### Call a tasks with command line args
If your task accepts command line arguments, just type them after the task name:

![](https://raw.githubusercontent.com/licht1stein/babashka.el/master/videos/3-args.gif)

### Call tasks from any directory
If you want to specify a `bb.edn` to run tasks from, simply call `babashka-tasks` with an interactive argument:

```
C-u M-x babashka-tasks RET
```

![](https://raw.githubusercontent.com/licht1stein/babashka.el/master/videos/2-interactive.gif)

### Make it a `project-switch-project` action
`project-switch-project` can be extended with custom dispatch
actions. To add a dispatch action which runs a Babashka task from the
project's root, add `babashka-project-tasks` to your
`project-switch-commands` list. For example:
```elisp
(setq project-switch-commands
      '((babashka-project-tasks "Babashka task" "t") ;; <--
        (magit-project-status "Magit status" "m")
        (project-find-file "Find file")
        (project-find-regexp "Find regexp")
        (project-find-dir "Find directory")
        (project-eshell "Eshell")
        ))
```

![](https://raw.githubusercontent.com/licht1stein/babashka.el/master/videos/4-project.gif)

## Customization
`babashka-command` - The command used to execute Babashka, if [CIDER](https://cider.mx/) is loaded, gets its default value from `cider-babashka-command`, so you don't need to customize both.

`babashka-async-shell-command` - a single-arity Emacs lisp function to call `babashka-command`. The default value is `async-shell-command`, another possible option is `detached-shell-command` from [detached.el](https://sr.ht/~niklaseklund/detached.el/) package.

`babashka-annotation-function` - a function to convert `tasks` hashtable to  (task . documentation) alist. The only available option now is `babashka--annotation-function`.

## Installation
Babashka.el is available on [MELPA](https://melpa.org/#/babashka) and [MELPA Stable](https://stable.melpa.org/#/babashka) and can be installed with:

```
M-x package-install RET babashka RET
```

or using `use-package` [ensure feature](https://github.com/jwiegley/use-package#package-installation):

```elisp
(use-package babashka)
```

Don't forget to explicitly ensure the installation:

```elisp
(use-package babashka
  :ensure t)
```
if `use-package-always-ensure` is not set.

## Versioning
The project uses [break versioning](https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md), meaning that upgrading from 1.0.x to 1.0.y will always be safe, upgrade to 1.y.0 might break something small, and upgrade to y.0.0. will break almost everything. That was a versioning spec in one sentence, by the way.

## Contributing
If you have more ideas about using babashka from Emacs — please submit a PR or a feature request.

babashka.el

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README