An open API service indexing awesome lists of open source software.

https://github.com/frap129/scxctl

A cli interface for scx_loader
https://github.com/frap129/scxctl

Last synced: about 9 hours ago
JSON representation

A cli interface for scx_loader

Awesome Lists containing this project

README

        

# scxctl

[![crates.io](https://img.shields.io/crates/v/scxctl.svg)](https://crates.io/crates/scxctl)
[![license](https://img.shields.io/crates/l/scxctl.svg)](https://crates.io/crates/scxctl)

> [!WARNING]
> **This repo is DEPRECATED**
> scxctl is now a part of the official [sched-ext/scx repo](https://github.com/sched-ext/scx/tree/main/tools/scxctl)

`scxctl` is a cli interface for interacting with `scx_loader`.

## Features
- Get the current scheduler and mode
- List all available schedulers
- Start a scheduler in a given mode, or with given arguments
- Switch between schedulers and modes
- Stop the running scheduler

## Installation

### Arch Linux
~`scxctl` is available on the AUR as [scxctl](https://aur.archlinux.org/packages/scxctl)~
> [!WARNING]
> scxctl is included in the official scx-scheds package for versions after 1.0.10

### Other Distros
`scxctl` can be installed from crates.io through cargo
```
cargo install scxctl
```

## Usage
```
$ scxctl --help
Usage: scxctl

Commands:
get Get the current scheduler and mode
list List all supported schedulers
start Start a scheduler in a mode or with arguments
switch Switch schedulers or modes, optionally with arguments
stop Stop the current scheduler
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version
```

```
$ scxctl start --help
Start a scheduler in a mode or with arguments

Usage: scxctl start [OPTIONS] --sched

Options:
-s, --sched Scheduler to start
-m, --mode Mode to start in [default: auto] [possible values: auto, gaming, powersave, lowlatency, server]
-a, --args Arguments to run scheduler with
-h, --help Print help
```

```
$ scxctl switch --help
Switch schedulers or modes, optionally with arguments

Usage: scxctl switch [OPTIONS]

Options:
-s, --sched Scheduler to switch to
-m, --mode Mode to switch to [possible values: auto, gaming, powersave, lowlatency, server]
-a, --args Arguments to run scheduler with
-h, --help Print help
```

### Examples:
Start bpfland in auto mode
```
scxctl start -s bpfland
```

Switch to gaming mode
```
scxctl switch -m gaming
```

Switch to lavd with verbose and performance flags
```
scxctl switch -s lavd -a="-v,--performance"
```