Rename binary to rnk (#6)

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "renku-cli"
+name = "rnk"
 description = "A command line interface to the Renku platform"
 homepage = "https://renkulab.io/"
 version = "0.1.0-nightly"

docs/index.md

@@ -1,12 +1,12 @@
 # Renku CLI
 
-This is the documentation for `renku-cli` the command line interface
-to the Renku platform.
+This is the documentation for the command line interface to the Renku
+platform.
 
 
 ## Installation
 
-The binary name for the renku-cli is `renku-cli`.
+The binary name for the renku-cli is `rnk`.
 
 ### Manual Download
 
@@ -17,9 +17,12 @@ If you run on MacOS, download the `*-darwin` binary. If you run some
 form of linux, try `*-amd64` or `*-aarch64`. Last for Windows use the
 `*-windows` binary.
 
+Once downloaded, you can simply execute it without any further
+installation step.
+
 ### Nix User
 
-If you are a nix user and have flakes enabled, you can install renku-cli
+If you are a nix user and have flakes enabled, you can install rnk
 from this repository:
 
 ```
@@ -46,5 +49,5 @@ get an overview of possible commands, run the binary without any
 options or adding `--help`.
 
 ``` bash renku-cli
-renku-cli --help
+rnk --help
 ```

mkdocs.sh

@@ -3,4 +3,4 @@
 set -e
 
 cargo build --release
-cargo run --features user-doc -- user-doc --output-dir target/docs --overwrite --renku-cli target/release/renku-cli docs/
+cargo run --features user-doc -- user-doc --output-dir target/docs --overwrite --renku-cli target/release/rnk docs/

src/cli/cmd/shell_completion.rs

@@ -10,7 +10,7 @@ pub struct Input {
     pub shell: GeneratorChoice,
 
     /// The binary name.
-    #[arg(long, default_value = "renku-cli")]
+    #[arg(long, default_value = "rnk")]
     pub binary: String,
 }
 

src/cli/cmd/userdoc.rs

@@ -47,8 +47,8 @@ pub struct Input {
     #[arg(long, group = "output")]
     pub output_dir: Option<PathBuf>,
 
-    /// The renku-cli binary program to use for running the snippets.
-    /// By default it will use itself.
+    /// The rnk binary program to use for running the snippets. By
+    /// default it will use itself.
     #[arg(long)]
     pub renku_cli: Option<PathBuf>,
 
@@ -207,7 +207,7 @@ fn write_to_file(file: &Path, content: &str, overwrite: bool, append: bool) -> R
     Ok(())
 }
 
-/// Process a markdown file by executing all included renku-cli
+/// Process a markdown file by executing all included rnk
 /// commands and inserting the results.
 ///
 /// The commands are taken from (fenced) code blocks marked with

src/cli/opts.rs

@@ -64,7 +64,7 @@ pub enum SubCommand {
 /// Repository: https://github.com/SwissDataScienceCenter/renku-cli
 /// Issue tracker: https://github.com/SwissDataScienceCenter/renku-cli/issues
 #[derive(Parser, Debug)]
-#[command(name = "renku-cli", version)]
+#[command(name = "rnk", version)]
 pub struct MainOpts {
     #[clap(flatten)]
     pub common_opts: CommonOpts,

src/httpclient.rs

@@ -5,7 +5,7 @@
 //! # Usage
 //!
 //! ```rust
-//! use renku_cli::httpclient;
+//! use rnk::httpclient;
 //! let client = httpclient::Client::new(
 //!    "https://renkulab.io",
 //!    httpclient::proxy::ProxySetting::System,

src/main.rs

@@ -1,4 +1,4 @@
-use renku_cli::error::{Error, Result};
+use rnk::error::{Error, Result};
 use std::env;
 use std::process;
 
@@ -15,7 +15,7 @@ async fn main() {
 }
 
 async fn execute() -> Result<()> {
-    let opts = renku_cli::read_args();
+    let opts = rnk::read_args();
     let remove_env = match opts.common_opts.verbose {
         1 => set_log_level("info"),
         n => {
@@ -28,7 +28,7 @@ async fn execute() -> Result<()> {
     };
     env_logger::init();
 
-    let result = renku_cli::execute_cmd(opts).await;
+    let result = rnk::execute_cmd(opts).await;
     if remove_env {
         env::remove_var(LOG_LEVEL);
     }

tests/common/mod.rs

@@ -27,7 +27,7 @@ impl std::convert::From<serde_json::Error> for Error {
 pub type Result<A> = std::result::Result<A, Error>;
 
 pub fn mk_cmd() -> Result<Command> {
-    let mut cmd = Command::cargo_bin("renku-cli")?;
+    let mut cmd = Command::cargo_bin("rnk")?;
     cmd.args(["--renku-url", "https://ci-renku-3668.dev.renku.ch"]); //use mock url?
     Ok(cmd)
 }

tests/version.rs

@@ -2,7 +2,7 @@ mod common;
 use crate::common::*;
 use assert_cmd::prelude::*;
 use predicates::prelude::*;
-use renku_cli::cli::BuildInfo;
+use rnk::cli::BuildInfo;
 
 #[test]
 #[ignore = "needs a server"]