Skip to content
This repository was archived by the owner on May 2, 2022. It is now read-only.

Commit 9b55b37

Browse files
committed
Merge branch 'main' of https://github.com/scmn-dev/tran
2 parents 62e7ee2 + 48c843e commit 9b55b37

1 file changed

Lines changed: 0 additions & 127 deletions

File tree

README.md

Lines changed: 0 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,10 @@
22
<img src="https://raw.githubusercontent.com/abdfnx/tran/main/.github/assets/logo.svg" height="120px" />
33
</p>
44

5-
<p align="center">
6-
<img src="https://user-images.githubusercontent.com/64256993/152999023-fbbe04aa-a4b5-449c-b589-27e1169cf851.gif" />
7-
</p>
8-
9-
<p align="center">
10-
<img src="https://user-images.githubusercontent.com/64256993/153002664-9c3db89e-5c71-4555-afa0-3866e37f5339.gif" />
11-
</p>
12-
135
> 🖥️ Securely transfer and send anything between computers with TUI.
146
15-
## Installation
16-
17-
### Using script
18-
19-
* Shell
20-
21-
```
22-
curl -fsSL https://cutt.ly/tran-cli | bash
23-
```
24-
25-
* PowerShell
26-
27-
```
28-
iwr -useb https://cutt.ly/tran-win | iex
29-
```
30-
31-
**then restart your powershell**
32-
33-
### Homebrew
34-
35-
```bash
36-
brew install abdfnx/tap/tran
37-
```
38-
39-
### GitHub CLI
40-
41-
```bash
42-
gh extension install abdfnx/gh-tran
43-
```
44-
457
## Usage
468

47-
* Open Tran UI
48-
49-
```bash
50-
tran
51-
```
52-
53-
* Open with specific path
54-
55-
```
56-
tran --start-dir $PATH
57-
```
58-
599
* Send files to a remote computer
6010

6111
```
@@ -67,80 +17,3 @@ tran send <FILE || DIRECTORY>
6717
```
6818
tran receive <PASSWORD>
6919
```
70-
71-
* Authenticate with github
72-
73-
```
74-
tran auth login
75-
```
76-
77-
* Sync your tran config file
78-
79-
```
80-
tran sync start
81-
```
82-
83-
### Tran Config file
84-
85-
> tran config file is located at `~/.config/tran/tran.yml` | `$HOME/tran.yml`
86-
87-
```yml
88-
config:
89-
borderless: false
90-
editor: vim
91-
enable_mousewheel: true
92-
show_updates: true
93-
start_dir: .
94-
```
95-
96-
### Flags
97-
98-
```
99-
--start-dir string Starting directory for Tran
100-
```
101-
102-
### Shortkeys
103-
104-
* <kbd>tab</kbd>: Switch between boxes
105-
* <kbd>up</kbd>: Move up
106-
* <kbd>down</kbd>: Move down
107-
* <kbd>left</kbd>: Go back a directory
108-
* <kbd>right</kbd>: Read file or enter directory
109-
* <kbd>V</kbd>: View directory
110-
* <kbd>T</kbd>: Go to top
111-
* <kbd>G</kbd>: Go to bottom
112-
* <kbd>~</kbd>: Go to your home directory
113-
* <kbd>/</kbd>: Go to root directory
114-
* <kbd>.</kbd>: Toggle hidden files and directories
115-
* <kbd>D</kbd>: Only show directories
116-
* <kbd>F</kbd>: Only show files
117-
* <kbd>E</kbd>: Edit file
118-
* <kbd>ctrl+s</kbd>: Send files/directories to remote
119-
* <kbd>ctrl+r</kbd>: Receive files/directories from remote
120-
* <kbd>ctrl+f</kbd>: Find files and directories by name
121-
* <kbd>q</kbd>/<kbd>ctrl+q</kbd>: Quit
122-
123-
### Technologies Used in Tran
124-
125-
- [**Charm**](https://charm.sh)
126-
- [**Chroma**](https://github.com/alecthomas/chroma)
127-
- [**Imaging**](https://github.com/disintegration/imaging)
128-
- [**Gorilla Websocket**](https://github.com/gorilla/websocket)
129-
- [**PAKE**](https://github.com/schollz/pake)
130-
- [**Cobra**](https://github.com/spf13/cobra)
131-
- [**Viper**](https://github.com/spf13/viper)
132-
- [**GJson**](https://github.com/tidwall/gjson)
133-
- [**Termenv**](https://github.com/muesli/termenv)
134-
135-
### Special thanks
136-
137-
thanks to [**@ZinoKader**](https://github.com/ZinoKader) for his awesome repo [`portal`](https://github.com/ZinoKader/portal)
138-
139-
### License
140-
141-
tran is licensed under the terms of [MIT](https://github.com/abdfnx/tran/blob/main/LICENSE) license.
142-
143-
144-
## Stargazers over time
145-
146-
[![Stargazers over time](https://starchart.cc/abdfnx/tran.svg)](https://starchart.cc/abdfnx/tran)

0 commit comments

Comments
 (0)