Skip to content

📝 Guide to run the CLI as a developer #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hirschfuchs merged 1 commit into from
Nov 20, 2025
Merged

📝 Guide to run the CLI as a developer #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,9 @@ The UI is available in two variants:
Via the terminal, you can open it by setting the flag: `tiny4linux-gui --start-as widget`

| Dashboard Mode | Widget Mode |
|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| <img src="src/assets/screenshot.png" height="400px" alt="Dashboard Mode"/> | <img src="src/assets/screenshot-widget.png" height="400px" alt="Widget Mode"/> |


### CLI

You can use the CLI by typing `t4l` or `tiny4linux-cli` in your terminal.
Expand All @@ -118,12 +117,24 @@ Therefore, using a VM — for example, via [VirtualBox](https://wiki.archlinux.o
Once you’ve set the color values, gesture settings, and preset camera positions once, there’s no need to start the VM regularly anymore.
The rest is what this program is meant to handle ;)

## Run the GUI (for devs)
## Run the Application (for devs)

### GUI

To run the GUI, you have to build the project and then run the binary:
To run the GUI, you have to build the project and then run the corresponding binary.
Remember to enable the `gui` feature:

```shell
cargo run --package tiny4linux --bin tiny4linux-gui
cargo run --package tiny4linux --bin tiny4linux-gui --features="gui"
```

With _Jetbrains RustRover_, you can directly execute the corresponding Run Configuration.
With _Jetbrains RustRover_, you can directly execute the Run Configuration.

### CLI

To run the CLI, you have to build the project and then run the corresponding binary.
Remember to enable the `cli` feature:

```shell
cargo run --package tiny4linux --bin tiny4linux-cli --features="cli"
```