From 31f39bfbd699a544437bd0ca9611f84c8c3fd67a Mon Sep 17 00:00:00 2001 From: blob42 Date: Mon, 27 Feb 2023 01:27:10 +0100 Subject: [PATCH] update doc --- README.md | 22 ++++++++++++++++------ rcargo | 3 --- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 28b8667..02b07fe 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ -My scripts/tools for rust development +Some scripts for rust development -### list of tools: -#### rcargo: +### 1. Remote Cargo CLI -Run remote cargo commands on remote workstation/server and output builds and -binaries into local machine. +#### Description -##### Todo: +**rcargo** is a command-line tool that allows you to build and install Rust binaries using cargo from a remote host and copy the binaries locally. It is useful for development and testing, especially when the local environment is not suitable for building the required binaries or if you want to build the binaries on remote workstation. + +available commands: + +- list: List the installed packages on the remote host. +- install: Install packages from crates.io with remote build. + + +### Contributing + +If you have any suggestions or find any bugs, please feel free to open an issue or a pull request + +### Todo: * [ ] Installing binaries * [x] install a package binary from crates.io * [x] handle custom install parameters for cargo diff --git a/rcargo b/rcargo index 5774db3..361449a 100755 --- a/rcargo +++ b/rcargo @@ -137,9 +137,6 @@ if __name__ == '__main__': install_parser.add_argument('package', nargs="*", help='package name', metavar='PACKAGE_NAME') - # catch any parameter for cargo commands - # for example if I run `rcargoos install --force package_name` it will be catched by any_cmd - build = subparsers.add_parser('build', help='remote build local cargo package')