README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# BARB-MODE

Barb-mode is a major mode for emacs to edit and interact with request
files for the [barb](https://gitlab.com/guillaume54/barb) HTTP query
tool.

![Animated demo](demo.gif)

## Installation

The supported method of installation is through the package manager
[straight.el](https://github.com/radian-software/straight.el). In
order to install barb-mode, add the following to your `init.el`:

```lisp
(straight-use-package
    '(barb-mode
      :type git
      :host gitlab 
      :repo "guillaume54/barb-mode"))
```

Then restart emacs.

## Usage

The mode will be automatically loaded whenever a `.barb` file is
visited. If you have chosen to use a different file extension, you can
start the mode by typing `M-x barb-mode`.

The mode provides syntax highlighting for the *barb* preamble and
allows easy execution of the request directly in emacs by typing `C-c
C-c`.

## Running a barb file

In order to execute a barb file, the
[barb](https://gitlab.com/guillaume54/barb#installation) executable
must be installed on your system and on the `PATH`. Then pressing `C-c
C-c` should work.