summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-06-14 22:50:55 +1000
committerGitHub <noreply@github.com>2025-06-14 22:50:55 +1000
commitee7291b7f64a359d17eb1d050086ef5357d79055 (patch)
treef1c200d8c8ba81030cbb2113a2be122db6508c8f /README.md
parentMerge pull request #5 from dalpax/patch-1 (diff)
parentMerge branch 'main' into python-rework (diff)
downloadcaelestia-cli-ee7291b7f64a359d17eb1d050086ef5357d79055.tar.gz
caelestia-cli-ee7291b7f64a359d17eb1d050086ef5357d79055.tar.bz2
caelestia-cli-ee7291b7f64a359d17eb1d050086ef5357d79055.zip
Merge pull request #6 from caelestia-dots/python-rework
feat: rewrite in python
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 8 insertions, 25 deletions
diff --git a/README.md b/README.md
index 3dfd494..607331d 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,17 @@
-# caelestia-scripts
+# caelestia-cli
-A collection of scripts for my caelestia dotfiles.
+The main control script for the Caelestia dotfiles.
## Installation
-Clone this repo.
+### Package manager
-Run `install/scripts.fish`.
-`~/.local/bin` must be in your path.
+TODO
-## Usage
+### Manual installation
-```
-> caelestia help
-Usage: caelestia COMMAND [ ...args ]
+TODO
-COMMAND := help | install | shell | toggle | workspace-action | scheme | screenshot | record | clipboard | clipboard-delete | emoji-picker | wallpaper | pip
+## Usage
- help: show this help message
- install: install a module
- shell: start the shell or message it
- toggle: toggle a special workspace
- workspace-action: execute a Hyprland workspace dispatcher in the current group
- scheme: change the current colour scheme
- variant: change the current scheme variant
- screenshot: take a screenshot
- record: take a screen recording
- clipboard: open clipboard history
- clipboard-delete: delete an item from clipboard history
- emoji-picker: open the emoji picker
- wallpaper: change the wallpaper
- pip: move the focused window into picture in picture mode or start the pip daemon
-```
+TODO