runslate

A shell dictionary created by Rust.

👽 API provider

• youdao
• google

🚧 Installation

Binary

Just download the binary file and put it into a directory which has been add to path.

From source

1. Visit rust-lang.org and select a suitable way to install Rust.
2. Clone this repo and run cargo build [--release].

📃 Usage

Ensure you have add environmental variables listed in .env, and runslate can find .env file:

1. Current directory.
2. Executable file's directory.
3. Application directory (~/.runslate/, usually).

# unix
source .env

1. The best way to use runslate is put it into a dir contained by env path and rename it into a shorter name so you can lookup words more conveniently. And more, put .env into that dir, too.
2. Type runslate -h for usage details, here are some options for example:
   • -t, --translator to select translator(API provider).
   • -s, --source-lang to set source language.
   • -d, --target-lang to set target language.
   • -v, --verbose show debug logs.
   • ...
3. runslate provides some env-vars for configuration, in .env:
   1. Use RUNSLATE_TRANSLATOR to pick translator. Available values: [youdao, google].
   2. Check env template file .env for more envs.
4. How does env work?
   1. First, runslate will try to read .env in current directory, executable file directory, app directory(~/.runslate) one by one. If env file loading fails, program would exit.
   2. Second, parse options:
      1. Some options are related to specified env-vars, if they were found, use them first.
      2. Use options' default values(if given).
      3. If there is not env-var neither default value, an error is reported.
   3. As for some circumstances like env conflicting, not tested yet.

🔨 Crates used

• clap: parse arguments.
• reqwest: http request.
• serde_json: json parse.
• env_logger: logging.
• dotenv: load env.

📄 Update log

• 2024-03-17 v0.4.4 It won't panic if .env file doesn't exist.
• 2023-08-15 v0.3.0 Load .env file from current dir, app-dir(~/.config/runslate/), exe-file dir one by one.
• 2023-08-15 v0.2.0 Save & load cache.
• v0.1.0 Main function released which contains Youdao and google api.