|
1 |
| -Sunbeam is a framework for writing keyboard-driven TUIs, by composing list, form and detail views. It's designed to be easy to use, and easy to extend. |
| 1 | +Sunbeam is a TUI framework for creating keyboard-driven applications from simple scripts. |
2 | 2 |
|
3 |
| -### Sunbeam runs on all platforms |
| 3 | +You can think of it as a mix between an application launcher like [raycast](https://raycast.com) and a fuzzy-finder like [fzf](https://github.com/junegunn/fzf). |
4 | 4 |
|
5 |
| -Sunbeam is distributed as a single binary, so you can run it on any platform. The sunbeam extension system is also designed to be cross-platform. |
| 5 | +[](https://asciinema.org/a/614506) |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +## Runs on all platforms |
| 10 | + |
| 11 | +Sunbeam is distributed as a single binary, available for all major platforms. Sunbeam also comes with a lot of utilities to make it easy to create cross-platform scripts. |
6 | 12 |
|
7 | 13 | 
|
8 | 14 |
|
9 |
| -### Sunbeam is language agnostic |
| 15 | +## Supports any language |
10 | 16 |
|
11 | 17 | Sunbeam provides multiple helpers for writing scripts in POSIX shell, but you can also use any other language.
|
12 | 18 |
|
13 | 19 | The only requirement is that your language of choice can read and write JSON.
|
14 | 20 |
|
15 | 21 | Example Extensions:
|
16 | 22 |
|
17 |
| -- [VS Code](https://github.com/pomdtr/sunbeam-vscode) |
18 |
| -- [File Browser](https://github.com/pomdtr/sunbeam-files) |
19 |
| -- [Bitwarden](https://github.com/pomdtr/sunbeam-bitwarden) |
20 |
| -- [Github](https://github.com/pomdtr/sunbeam-github) |
21 |
| -- [TLDR Pages](https://github.com/pomdtr/sunbeam-tldr) |
22 |
| -- [Devdocs](https://github.com/pomdtr/sunbeam-devdocs) |
| 23 | +- [VS Code (typescript)](https://github.com/pomdtr/sunbeam-vscode) |
| 24 | +- [File Browser (python)](https://github.com/pomdtr/sunbeam-files) |
| 25 | +- [Bitwarden (sh)](https://github.com/pomdtr/sunbeam-bitwarden) |
| 26 | +- [Github (sh)](https://github.com/pomdtr/sunbeam-github) |
| 27 | +- [TLDR Pages (sh)](https://github.com/pomdtr/sunbeam-tldr) |
| 28 | +- [Devdocs (sh)](https://github.com/pomdtr/sunbeam-devdocs) |
23 | 29 |
|
24 |
| -### Sunbeam is easy to extend |
| 30 | +### Easy to extend |
25 | 31 |
|
26 | 32 | Instead of reiventing the wheel, sunbeam relies on your familiarity with git and github to make it easy to create, update, publish and install extensions.
|
27 | 33 |
|
28 |
| -Creating a new extension is as easy as writing a script. Sunbeam supports installing extension from any github repository, and can also interact with REST APIs. |
| 34 | +Creating a new extension is as easy as writing a script.\ |
| 35 | +Sharing an extension is as easy as pushing it to github. |
29 | 36 |
|
30 |
| -Since sunbeam uses `git` under the hood, allowing you to create private extensions by using private git repositories. |
| 37 | +If you prefer, you can also distribute your extensions as http endpoints, and use sunbeam as a client. |
31 | 38 |
|
32 | 39 | 
|
33 | 40 |
|
34 |
| -### Sunbeam supports custom clients |
| 41 | +### Bring your own UI |
35 | 42 |
|
36 | 43 | Sunbeam comes with a built-in TUI to interact with your scripts, but you can also use any other client.
|
37 | 44 |
|
38 |
| -Currently the only alternative client is [sunbeam-raycast](https://github.com/pomdtr/sunbeam-raycast). |
| 45 | +See the client section for more details. |
39 | 46 |
|
40 | 47 | 
|
41 | 48 |
|
|
0 commit comments