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
42
43

# Sydney

[![crates.io](https://img.shields.io/crates/v/sydney.svg)](https://crates.io/crates/sydney)
[![github.com](https://github.com/gemrest/sydney/actions/workflows/rust.yaml/badge.svg?branch=main)](https://github.com/gemrest/sydney/actions/workflows/rust.yaml)

Sydney is a Vim-like, command-line Gemini client.

Sydney has a beautiful, intuitive, and powerful command-line interface;
including:

- Vim-like keybindings
- Vim-like commands
- Intuitive link handling
- Understandable errors
- Customizable UI

## Usage

### Installation

```shell
cargo install sydney --force
```

### Help

```shell
usage: syndey [option, capsule_uri]
Options:
    --version, -v    show version text
    --help, -h       show help text

Sample invocations:
    syndey gemini://gem.rest/
    syndey --help

Report bugs to https://github.com/gemrest/sydney/issues

```

## License

This project is licensed with the [GNU General Public License v3.0](https://github.com/gemrest/sydney/blob/main/LICENSE).