mirror of
https://github.com/darmiel/yaxc.git
synced 2024-11-10 09:03:00 +08:00
Merge branch 'main' of github.com:darmiel/yaxc into main
This commit is contained in:
darmiel
commit
1251045cc7
1 changed files with 132 additions and 113 deletions
245
README.md
245
README.md
|
|
@ -1,119 +1,46 @@
|
|||
# YAxC
|
||||
Yet Another Cross Clipboard
|
||||
> Allan, please add details!
|
||||
<!-- Logo -->
|
||||
<p align="center">
|
||||
<img src="./assets/YAxC-Filled@128px.png" alt="yaxc">
|
||||
</p>
|
||||
|
||||
## API
|
||||
✨ API Docs moved to: [api.yaxc.d2a.io](https://api.yaxc.d2a.io)
|
||||
<!-- Header -->
|
||||
<h1 align="center">YAxC</h1>
|
||||
<p align="center">
|
||||
<strong>Y</strong>et
|
||||
<strong>A</strong>nother
|
||||
<i>Cross</i>
|
||||
<strong>C</strong>lipboard
|
||||
</p>
|
||||
|
||||
## Demo
|
||||
https://youtu.be/OVpH70byKRQ
|
||||
<!-- Links -->
|
||||
<p align="center">
|
||||
[
|
||||
<a href="https://github.com/darmiel/yaxc/releases">📦 Download</a> |
|
||||
<a href="https://api.yaxc.d2a.io">📚 API-Docs</a> |
|
||||
<a href="https://youtu.be/OVpH70byKRQ" target="_blank">🎥 Demo</a> |
|
||||
<a href="#client">⌨️ Usage</a>
|
||||
]
|
||||
</p>
|
||||
|
||||
## CLI
|
||||
### Send Clipboard (one-time)
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc force push [flags]
|
||||
## Introduction
|
||||
YAxC is my attempt to develop a cross-platform clipboard that is as simple as possible. YAxC consists of two components:
|
||||
|
||||
Flags:
|
||||
-h, --help help for push
|
||||
### Server
|
||||
The server was kept very minimalistic and simple:
|
||||
|
||||
Global Flags:
|
||||
-a, --anywhere string Anywhere Path
|
||||
-b, --base64 Use Base64
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
-S, --hide-secret Hide Secret
|
||||
-U, --hide-url Hide URL
|
||||
-s, --secret string Encryption Key
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
```
|
||||
The server accepts a `POST` request (`text/plain`) to any path `/{anywhere}` (except `/` and `/hash`) and stores the sent data there for 5 minutes by default, but this can be changed with the `ttl` query-parameter. An MD5 hash is then generated and can be retrieved at `/hash/{anywhere}`.
|
||||
|
||||
This hash is used to see if the data has changed on the server. This hash can also be specified during the upload, e.g. if you want to use a different hash method.
|
||||
|
||||
For more information, see the 📚 API docs [here](https://api.yaxc.d2a.io)
|
||||
|
||||
#### 🖥 Host Your Own Server
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc force push -a mypath [-s mypassword]
|
||||
# INFO | Sent -> hello wor... -> /mypath
|
||||
# INFO | 🔐 mypassword
|
||||
# DBUG | URL: https://yaxc.d2a.io/mypath?secret=mypassword
|
||||
$ yaxc serve -b :80
|
||||
# INFO | Started clipboard-server. Press CTRL-C to stop.
|
||||
```
|
||||
|
||||
### Receive Data And Paste To Clipboard (one-time)
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc force pull [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for pull
|
||||
|
||||
Global Flags:
|
||||
-a, --anywhere string Anywhere Path
|
||||
-b, --base64 Use Base64
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
-S, --hide-secret Hide Secret
|
||||
-U, --hide-url Hide URL
|
||||
-s, --secret string Encryption Key
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
```
|
||||
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc force pull -a mypath [-s mypassword]
|
||||
# INFO | Read <- hello wor...
|
||||
```
|
||||
|
||||
### Receive Data And Output To Stdin (one-time)
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc get [flags]
|
||||
|
||||
Flags:
|
||||
-a, --anywhere string Path (Anywhere)
|
||||
-h, --help help for get
|
||||
-s, --passphrase string Encryption Key
|
||||
|
||||
Global Flags:
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
|
||||
```
|
||||
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc get -a mypath [-s mypassword]
|
||||
# Hello world!
|
||||
```
|
||||
|
||||
### Watch Clipboard (Clipboard Sync)
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc watch [flags]
|
||||
|
||||
Flags:
|
||||
-a, --anywhere string Path (Anywhere)
|
||||
-b, --base64 Use Base64?
|
||||
-h, --help help for watch
|
||||
--ignore-client Ignore Client Updates
|
||||
--ignore-server Ignore Server Updates
|
||||
-s, --passphrase string Encryption Key
|
||||
|
||||
Global Flags:
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
```
|
||||
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc watch -a mypath [-b -s mypassword]
|
||||
# INFO | Starting Watchers:
|
||||
# INFO | * Server -> Client
|
||||
# INFO | * Server <- Client
|
||||
# INFO | Started clipboard-watcher. Press CTRL-C to stop.
|
||||
# UPDT | Server <- Hello Wor...
|
||||
```
|
||||
|
||||
### Host Your Own Server
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
|
|
@ -133,21 +60,113 @@ Flags:
|
|||
--redis-pass string Redis Password
|
||||
--redis-prefix-hash string Redis Prefix (Hash) (default "yaxc::hash::")
|
||||
--redis-prefix-value string Redis Prefix (Value) (default "yaxc::val::")
|
||||
|
||||
Global Flags:
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
```
|
||||
|
||||
### Client
|
||||
The client is a command line interface that provides the following functions:
|
||||
|
||||
#### 👉 Send Clipboard (one-time)
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc serve -b :80
|
||||
# INFO | Started clipboard-server. Press CTRL-C to stop.
|
||||
$ yaxc force push -a mypath [-s mypassword]
|
||||
# INFO | Sent -> hello wor... -> /mypath
|
||||
# INFO | 🔐 mypassword
|
||||
# DBUG | URL: https://yaxc.d2a.io/mypath?secret=mypassword
|
||||
```
|
||||
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc force push [flags]
|
||||
|
||||
Global Flags:
|
||||
-a, --anywhere string Anywhere Path
|
||||
-b, --base64 Use Base64
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
-S, --hide-secret Hide Secret
|
||||
-U, --hide-url Hide URL
|
||||
-s, --secret string Encryption Key
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
```
|
||||
|
||||
#### 👈 Receive Data And Paste To Clipboard (one-time)
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc force pull -a mypath [-s mypassword]
|
||||
# INFO | Read <- hello wor...
|
||||
```
|
||||
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc force pull [flags]
|
||||
|
||||
Global Flags:
|
||||
-a, --anywhere string Anywhere Path
|
||||
-b, --base64 Use Base64
|
||||
--config string config file (default is $HOME/.yaxc.yaml)
|
||||
-S, --hide-secret Hide Secret
|
||||
-U, --hide-url Hide URL
|
||||
-s, --secret string Encryption Key
|
||||
--server string URL of API-Server (default "https://yaxc.d2a.io")
|
||||
```
|
||||
|
||||
#### 👈 Receive data and output them (one-time)
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc get -a mypath [-s mypassword]
|
||||
# Hello world!
|
||||
```
|
||||
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc get [flags]
|
||||
|
||||
Flags:
|
||||
-a, --anywhere string Path (Anywhere)
|
||||
-h, --help help for get
|
||||
-s, --passphrase string Encryption Key
|
||||
|
||||
```
|
||||
|
||||
#### ♻️ Watch Clipboard (Clipboard Sync)
|
||||
**EXAMPLE**
|
||||
```bash
|
||||
$ yaxc watch -a mypath [-b -s mypassword]
|
||||
INFO | Started clipboard-watcher. Press CTRL-C to stop.
|
||||
UPDT | Server <- Hello Wor...
|
||||
```
|
||||
|
||||
**HELP**
|
||||
```
|
||||
Usage:
|
||||
yaxc watch [flags]
|
||||
|
||||
Flags:
|
||||
-a, --anywhere string Path (Anywhere)
|
||||
-b, --base64 Use Base64?
|
||||
-h, --help help for watch
|
||||
--ignore-client Ignore Client Updates
|
||||
--ignore-server Ignore Server Updates
|
||||
-s, --passphrase string Encryption Key
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Useful aliases
|
||||
```bash
|
||||
alias yfll='yaxc force pull -a anywhere'
|
||||
# PUSH
|
||||
# push clipboard contents (one-time) to /anywhere
|
||||
alias yfsh='yaxc force push -a anywhere'
|
||||
|
||||
# push clipboard contents (one-time) encrypted to /anywhere
|
||||
alias yfshs='yaxc force push -a anywhere -s secret'
|
||||
|
||||
# PULL
|
||||
# pull clipboard contents (one-time) to /anywhere
|
||||
alias yfll='yaxc force pull -a anywhere'
|
||||
|
||||
# pull encrypted clipboard contents (one-time) to /anywhere
|
||||
alias yflls='yaxc force pull -a anywhere -s secret'
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue