diff options
| author | Alexey 'Cluster' Avdyukhin <ClusterM@users.noreply.github.com> | 2017-03-04 22:22:42 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-04 22:22:42 +0300 |
| commit | c316f016ca6a0ad77c2751922ec0ba4aa2d52364 (patch) | |
| tree | 787b06566d157537350e5b6dde20d63921999486 | |
| parent | 3c6c6bf961ff314032a389f09a073bf0fcdd030c (diff) | |
Readme!0.1
| -rw-r--r-- | README.md | 35 |
1 files changed, 33 insertions, 2 deletions
@@ -1,2 +1,33 @@ -# clovershell-client -Client for hakchi mod which allows to access NES Mini's shell, execute commands and transfer files directly via USB, without UART and FEL. +# clovershell client # +Client for hakchi mod (https://github.com/ClusterM/clovershell-daemon) which allows to access NES Mini's shell, execute commands and transfer files directly via USB, without UART and FEL. + +## Usage ## + + clovershell shell [port] + clovershell exec <command> [stdin [stdout [stderr]]] + clovershell pull <remote_file> [local_file] + clovershell push <local_file> <remote_file> + +## Examples ## + + Start shell server on port 23: + clovershell shell 23 + List files: + clovershell exec "ls /etc/" + Download file: + clovershell pull /etc/inittab inittab + Upload file: + clovershell push inittab /etc/inittab + Archive and download files: + clovershell exec "cd /etc && tar -czv *" > file.tar.gz + Archive and download files (alternative): + clovershell exec "cd /etc && tar -czv *" null file.tar.gz + Upload and extract files: + clovershell exec "cd /etc && tar -xzv" file.tar.gz + Upload and extract files (alternative): + clovershell exec "cd /etc && tar -xzv" - <file.tar.gz + Dump the whole decrypted filesystem: + clovershell exec "dd if=/dev/mapper/root-crypt | gzip" > dump.img.gz + Dump the whole decrypted filesystem (alternative): + clovershell exec "dd if=/dev/mapper/root-crypt | gzip" null dump.img.gz + |