Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominicrico/hyprsession
Save the current hyprland clients and restore them on hyprland start
https://github.com/dominicrico/hyprsession
Last synced: 22 days ago
JSON representation
Save the current hyprland clients and restore them on hyprland start
- Host: GitHub
- URL: https://github.com/dominicrico/hyprsession
- Owner: dominicrico
- License: gpl-3.0
- Created: 2024-12-13T17:25:10.000Z (25 days ago)
- Default Branch: main
- Last Pushed: 2024-12-13T17:34:44.000Z (25 days ago)
- Last Synced: 2024-12-13T18:32:34.194Z (25 days ago)
- Language: TypeScript
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# HyprSession
HyprSession is a utility designed to store and restore window sessions for Hyprland, a dynamic tiling window manager for Linux. Initially created using [Bun.js](https://bun.sh), the tool is compiled into a binary for seamless usage on Linux systems.
https://github.com/user-attachments/assets/d3013c0f-d0be-4563-ab18-a98a839c7d4b
> [!NOTE]
> Most of it should work and depending on the window count it will take a while.
> This is through the nature of hyprland.
> Also please note applications like chromium (if you use multiple windows)
> or vesktop/vencord (if you need to login) will not be restored correctly.
> This will hopefully work in a future release.
## 🚀 Features
- **Save and Restore Sessions**: Quickly save your current window layout and restore it later.
- **Automatic Session Saving**: Periodically save running sessions with customizable intervals.
## 👷 Installation
1. Download the precompiled binary from the [releases](https://github.com/dominicrico/hyprsession/releases) section.
2. Move the binary to a directory in your `PATH` (e.g., `/usr/local/bin`).
3. Make it executable:
```bash
chmod +x /usr/local/bin/hyprsession
```
4. Add it to your hyprland.conf
```bash
exec-once = hyprsession
# or
exec-once = hyprsession --silent
```
## 🛠 Usage
```bash
$ hyprsession
```
### Options
| Option | Alias | Description | Default |
|------------------------|-------|---------------------------------------------|---------------|
| `--restore-session` | `-r` | Restores the last session | |
| `--save-session` | `-s` | Saves the current session | |
| `--auto-save` | `-a` | Periodically save running sessions | `true` |
| `--interval` | `-i` | Time between auto saves (in seconds) | `60` |
| `--silent` | `-x` | Suppress all output to stdout | |
| `--debug` | `-v` | Print debug logs | |
| `--help` | | Shows help text | |
### Examples
#### Save the Current Session
```bash
$ hyprsession --save-session
```
#### Restore the Last Session
```bash
$ hyprsession --restore-session
```
#### Disable Auto-Save for a Single Command
```bash
$ hyprsession --save-session --auto-save=false
```
## 💻 Development
HyprSession was initially developed with [Bun.js](https://bun.sh) and compiled into a binary. Contributions are welcome! Feel free to open issues or pull requests to improve the tool.
## 🏆 Roadmap
- [ ] Fix Chromium multi window issue
- [ ] Fix Vencord if login is needed
- [ ] Create, save and restore sessions by name
- [ ] Make it faster
## 🧑⚖ License
This project is licensed under the [GPL-3.0 License](LICENSE).
## ‼️ Acknowledgments
- [Hyprland](https://hyprland.org) - The dynamic tiling window manager for Linux.
- [Bun.js](https://bun.sh) - A modern JavaScript runtime that helped bootstrap this project.