blob: a57621799177eb40e0b24909816f55faf00ed333 (
plain)
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
[](https://github.com/kamiyaa/joshuto/actions/workflows/rust-linux-main.yml)
[](https://github.com/kamiyaa/joshuto/actions/workflows/rust-macos-main.yml)
# joshuto
[ranger](https://github.com/ranger/ranger)-like terminal file manager written in Rust.
## Dependencies
- [cargo](https://github.com/rust-lang/cargo/) >= 1.55
- [rustc](https://www.rust-lang.org/) >= 1.55
- xsel/xclip/wl-clipboard (optional, for clipboard support)
- fzf (optional)
- zoxide (optional)
Also see [Cargo.toml](Cargo.toml)
## Building
```
~$ cargo build
```
## Installation
#### For single user
```
~$ cargo install --path=. --force
```
#### For single user with cargo
```
~$ cargo install --git https://github.com/kamiyaa/joshuto.git --force
```
#### System wide
```
~# cargo install --path=. --force --root=/usr/local # /usr also works
```
#### Packaging status
##### Fedora ([COPR](https://copr.fedorainfracloud.org/coprs/atim/joshuto/))
```
sudo dnf copr enable atim/joshuto -y
sudo dnf install joshuto
```
##### Arch ([AUR](https://aur.archlinux.org))
- [release](https://aur.archlinux.org/packages/joshuto)
```
[yay/paru] -S joshuto
```
- [build from source](https://aur.archlinux.org/packages/joshuto-git)
```
[yay/paru] -S joshuto-git
```
##### Gentoo ([gentoo-zh](https://github.com/microcai/gentoo-zh/tree/master/app-misc/joshuto))
```
sudo eselect repository enable gentoo-zh
sudo emerge -av app-misc/joshuto
```
##### NixOS
> Here's an example of using it in a nixos configuration
```nix
{
description = "My configuration";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
joshuto.url = "github:kamiyaa/joshuto";
};
outputs = { nixpkgs, joshuto, ... }:
{
nixosConfigurations = {
hostname = nixpkgs.lib.nixosSystem
{
system = "x86_64-linux";
modules = [
{
nixpkgs.overlays = [ joshuto.overlays.default ];
environment.systemPackages = with pkgs;[
joshuto
];
}
];
};
};
};
}
```
> Temporary run, not installed on the system
```sh
nix run github:kamiyaa/joshuto
```
##### MacOS ([MacPorts](https://ports.macports.org/port/joshuto/details/))
```
sudo port install joshuto
```
## Usage
```
~ $ joshuto
```
See [docs#quit](/docs/configuration/keymap.toml.md#quit-quit-joshuto) for exiting into current directory
and other usages
## Configuration
Check out [docs](/docs) for details and [config](/config) for examples
#### [joshuto.toml](/config/joshuto.toml)
- general configurations
#### [keymap.toml](/config/keymap.toml)
- for keybindings
#### [mimetype.toml](/config/mimetype.toml)
- for opening files with applications
#### [theme.toml](/config/theme.toml)
- color customizations
#### [bookmarks.toml](/config/bookmarks.toml)
- bookmarks
## Contributing
See [docs](/docs)
## Bugs/Feature Request
Please create an issue :)
## Features
- Tabs
- Devicons
- Fuzzy search via [fzf](https://github.com/junegunn/fzf)
- Ctrl/Shift/Alt support
- Bulk rename
- File previews
- See [Image previews](/docs/image_previews.md) for more details
- Exit to current directory
- Asynch File IO (cut/copy/paste)
- Custom colors/theme
- Line numbers
- Jump to number
- File chooser
- Trash support
## TODOs
- [x] Built-in command line
- Mostly working
- Currently implementation is kind of janky
- [ ] Tab autocomplete (in progress)
|
