-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update root command usage, update the tran README
- Loading branch information
Showing
2 changed files
with
117 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,115 @@ | ||
# Tran - under maintenance 🚧 | ||
<p align="center"> | ||
<img src="https://raw.githubusercontent.com/abdfnx/tran/main/.github/assets/logo.svg" height="120px" /> | ||
</p> | ||
|
||
<!-- Here's the demo file --> | ||
|
||
> 🖥️ Securely transfer and send anything between computers with TUI. | ||
## Installation | ||
|
||
<details> | ||
<summary><strong>ways</strong></summary> | ||
|
||
### Using script | ||
|
||
* Shell | ||
|
||
``` | ||
curl -fsSL https://cutt.ly/tran | bash | ||
``` | ||
|
||
* PowerShell | ||
|
||
``` | ||
iwr -useb https://cutt.ly/tran-win | iex | ||
``` | ||
|
||
**then restart your powershell** | ||
|
||
### Homebrew | ||
|
||
```bash | ||
brew install abdfnx/tap/tran | ||
``` | ||
|
||
### Go package manager | ||
|
||
```bash | ||
go install github.com/abdfnx/tran@latest | ||
``` | ||
|
||
### GitHub CLI | ||
|
||
```bash | ||
gh extension install abdfnx/gh-tran | ||
``` | ||
</details> | ||
|
||
## Usage | ||
|
||
* Open Tran UI | ||
|
||
```bash | ||
tran | ||
``` | ||
|
||
* Open with specific path | ||
|
||
``` | ||
tran --start-dir $PATH | ||
``` | ||
* Send files to a remote computer | ||
``` | ||
tran send <FILE || DIRECTORY> | ||
``` | ||
* Receive files from a remote computer | ||
``` | ||
tran receive <PASSWORD> | ||
``` | ||
|
||
### Tran Config file | ||
|
||
> tran config file is located at `~/.config/tran/tran.yml` | `$HOME/tran.yml` | ||
```yml | ||
config: | ||
borderless: false | ||
editor: vim | ||
enable_mousewheel: true | ||
show_updates: true | ||
start_dir: . | ||
``` | ||
### Flags | ||
``` | ||
--start-dir string Starting directory for Tran | ||
``` | ||
|
||
### Shortkeys | ||
|
||
* <kbd>tab</kbd>: Switch between boxes | ||
* <kbd>up</kbd>: Move up | ||
* <kbd>down</kbd>: Move down | ||
* <kbd>left</kbd>: Go back a directory | ||
* <kbd>right</kbd>: Read file or enter directory | ||
* <kbd>V</kbd>: View directory | ||
* <kbd>T</kbd>: Go to top | ||
* <kbd>G</kbd>: Go to bottom | ||
* <kbd>~</kbd>: Go to your home directory | ||
* <kbd>/</kbd>: Go to root directory | ||
* <kbd>.</kbd>: Toggle hidden files and directories | ||
* <kbd>D</kbd>: Only show directories | ||
* <kbd>F</kbd>: Only show files | ||
* <kbd>E</kbd>: Edit file | ||
* <kbd>ctrl+s</kbd>: Send files/directories to remote | ||
* <kbd>ctrl+r</kbd>: Receive files/directories from remote | ||
* <kbd>ctrl+f</kbd>: Find files and directories by name | ||
* <kbd>q</kbd>/<kbd>ctrl+q</kbd>: Quit | ||
|
||
### License | ||
|
||
tran is licensed under the terms of [MIT](https://github.com/abdfnx/tran/blob/main/LICENSE) license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters