A CLI system information tool written in Rust.
## Installation
### Install with Cargo
You can use cargo to install the latest version of Afetch:
```cargo
cargo install --locked afetch
```
### Build manually
Start by cloning the repo:
```bash
git clone https://github.com/Asthowen/AFetch.git
```
**For the next step you need to have Rust and cargo installed on your PC, for that follow the [official documentation](https://www.rust-lang.org/tools/install).**
Now switch to project folder and compile a release:
```bash
cd AFetch && cargo build --release
```
Your executable will be in the `target/release/` folder, it is named `afetch`.
## Configuration
### Locations of the configuration file
**Linux** -> `$XDG_CONFIG_HOME/afetch` or `$HOME/.config/afetch`
**Windows** -> `%APPDATA%\Roaming\afetch`
**MacOS** -> `$HOME/Library/Application Support/afetch`
### Configuration options
#### - Language
**Key name**: language
**Description**: The language used by AFetch.
**Available**: auto / fr / en
**Default**: auto
#### - Disable entries
**Key name**: disabled_entries
**Description**: List of entries to be deactivated.
**Available**: os / host / kernel / uptime / packages / resolution / desktop / desktop-version / shell / terminal / terminal-font / memory / cpu / cpu-usage / network / disk / disks / public-ip / battery / color-blocks
**Default**: network, battery, cpu-usage & public-ip
**Example**:
```yaml
disabled_entries:
- battery
- public-ip
- network
```
#### - Logo
**Key name**: logo
**Description**: Allows you to customize the logo.
**Example**:
```yaml
logo:
status: enable # disable / enable
char_type: braille # braille / picture
picture_path: none # `the file path: eg: ~/pictures/some.png` / none
```
#### - Text Color
**Key name**: text_color
**Description**: Allows you to customize the color of printed information.
**Example**:
```yaml
text_color:
- 255 # r
- 255 # g
- 255 # b
```
#### - Text Header Color
**Key name**: text_color
**Description**: Allows you to customize the color of printed information header.
**Example**:
```yaml
text_color_header:
- 133 # r
- 218 # g
- 249 # b
```
## Contributors
[
](https://github.com/Asthowen)
[
](https://github.com/SquitchYT)
## License
**[AFetch](https://github.com/Asthowen/AFetch) | [GNU General Public License v3.0](https://github.com/Asthowen/AFetch/blob/main/LICENSE)**
