[FEAT]: Offline installation documentation help #313

Closed
opened 2026-01-05 14:49:39 +01:00 by adam · 4 comments
Owner

Originally created by @pjhfggij on GitHub (Mar 24, 2024).

Is your feature request related to a problem? Please describe.
Documentation for offline installation missing - could you please help me piece it together?

Describe the solution you'd like
For example:

  1. Download .msi installers for komorebi and whkd (is it equivalent to winget install LGUG2Z.komorebi LGUG2Z.whkd?)
  2. Download and save configuration files (which files to download to replicate komorebic quickstart?)
    Are there any other steps missing compared to the documented installation procedure?

Describe alternatives you've considered

Additional context
Installing in a windows virtual machine without internet connection.

Originally created by @pjhfggij on GitHub (Mar 24, 2024). **Is your feature request related to a problem? Please describe.** Documentation for offline installation missing - could you please help me piece it together? **Describe the solution you'd like** For example: 1. Download .msi installers for [komorebi](https://github.com/LGUG2Z/komorebi/releases) and [whkd](https://github.com/LGUG2Z/whkd/releases) (is it equivalent to `winget install LGUG2Z.komorebi LGUG2Z.whkd`?) 2. Download and save configuration files (which files to download to replicate `komorebic quickstart`?) Are there any other steps missing compared to the documented installation procedure? **Describe alternatives you've considered** - **Additional context** Installing in a windows virtual machine without internet connection.
adam added the enhancement label 2026-01-05 14:49:39 +01:00
adam closed this issue 2026-01-05 14:49:39 +01:00
Author
Owner

@LGUG2Z commented on GitHub (Mar 24, 2024):

I think we can make offline installation even simpler by bundling example configs into the built code with something like include_str!; this would also remove almost all http requests to GitHub in the code which sometimes result in false positives from AV tools.

With this change the offline installation and setup steps would be largely the same because the quickstart command won't need make any http calls anymore.

@LGUG2Z commented on GitHub (Mar 24, 2024): I think we can make offline installation even simpler by bundling example configs into the built code with something like `include_str!`; this would also remove almost all http requests to GitHub in the code which sometimes result in false positives from AV tools. With this change the offline installation and setup steps would be largely the same because the `quickstart` command won't need make any http calls anymore.
Author
Owner

@pjhfggij commented on GitHub (Mar 24, 2024):

+1 That would be perfect for my use case

@pjhfggij commented on GitHub (Mar 24, 2024): +1 That would be perfect for my use case
Author
Owner

@pjhfggij commented on GitHub (Mar 29, 2024):

Thank you for adding this feature. In case someone has used .msi installers for komorebi and wkhd already and is only looking for configuration files this seemed to work for me:

  • komorebi config (copy to home and rename to komorebi.json)
  • wkhd config (copy to ~/.config)
  • komorebi-application-specific-configuration (copy to home)
wget https://raw.githubusercontent.com/LGUG2Z/komorebi-application-specific-configuration/master/applications.yaml
wget https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi/docs/komorebi.example.json
wget https://raw.githubusercontent.com/LGUG2Z/komorebi/master/docs/whkdrc.sample

Cursory look over the main.rs:SubCommand::Quickstart function seems to confirm that there isn't anything else the komorebic quickstart command is doing. If there's something I missed please let me know.

@pjhfggij commented on GitHub (Mar 29, 2024): Thank you for adding this feature. In case someone has used .msi installers for komorebi and wkhd already and is only looking for configuration files this seemed to work for me: - komorebi config (copy to home and rename to `komorebi.json`) - wkhd config (copy to `~/.config`) - komorebi-application-specific-configuration (copy to home) ```sh wget https://raw.githubusercontent.com/LGUG2Z/komorebi-application-specific-configuration/master/applications.yaml wget https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi/docs/komorebi.example.json wget https://raw.githubusercontent.com/LGUG2Z/komorebi/master/docs/whkdrc.sample ``` Cursory look over the main.rs:SubCommand::Quickstart function seems to confirm that there isn't anything else the `komorebic quickstart` command is doing. If there's something I missed please let me know.
Author
Owner

@LGUG2Z commented on GitHub (Mar 29, 2024):

Note to self that the docs still need to be added here for v0.1.23: https://lgug2z.github.io/komorebi/installation.html

@LGUG2Z commented on GitHub (Mar 29, 2024): Note to self that the docs still need to be added here for v0.1.23: https://lgug2z.github.io/komorebi/installation.html
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/komorebi#313