osatui

Terminal UI client for educational schedule API with interactive college, campus and group selection.

Features

• Interactive selection of colleges, campuses and groups
• Daily schedule viewing with navigation
• Customizable themes
• Local caching for faster loading
• Keyboard-driven interface
• Automatic configuration setup

Installation

• via cargo cargo install osatui

• via nix flake.nix

    {
      inputs = {
        osatui.url = "github:Bircoder432/osatui"
      };
  
      outputs = {self, ... }@inputs:
      {
        nixosConfigurations = {
          your = nixpkgs.lib.nixosSystem {
            specialArgs = { inherit inputs; };
            modules = [
              # ...
              home-manager.nixosModules.home-manager
              {
                home-manager.extraSpecialArgs = { inherit inputs; };
              }
            ];
          };
        };
      };
    }

  home manage

    { conifg, pkgs, inputs, ... }:
  
    {
      imports = [ inputs.osatui.homeManagerModules.your-system.osatui ];
      programs.osatui.enable = true;
      programs.osatui.package = inputs.osatui.packages.${pkgs.system}.osatui;
      programs.osatui.settings = {
        api = {
          url = "https://your.api-provider.com"; # Your OpenScheduleApi provider
          college_id = 1; # ID of your college in api
          campus_id = 1; # ID of your campus
          group_id = 161; # ID of your group
        };
        keymap = {
          prev_day = "Left"; # Key for move to previous day
          cur_day = "Up"; # Key for move to current day
          next_day = "Right"; # Key for move to next day
        };
      };
    }

Usage

osatui

Keybindings

Normal Mode:

• F1 - Previous day
• F2 - Today
• F3 - Next day
• Ctrl+O - Open selector to change group
• Ctrl+S - Open settings
• Q - Quit

Selector Mode:

• ↑/↓ - Navigate items
• ←/→ - Change pages
• Enter - Select item
• Esc - Cancel

Configuration

Configuration files are automatically created in system config directory.

Example config.toml

[api]
url = "https://api.example.com"
college_id = 1
campus_id = 1
group_id = 1

[app]
refresh_interval = 300
cache_enabled = true
cache_ttl = 3600
current_theme = "dark"

Related Projects

This project is built on top of:

• OpenScheduleApi - The backend API providing educational schedule data
• osars - Rust client library for OpenScheduleApi

License

MIT