Skip to content

馃摑 Added documentation for config-dir command #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Schneegans merged 2 commits into from
Aug 30, 2026
Merged

馃摑 Added documentation for config-dir command #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54e17a7
馃摑 Added documentation for config-dir command
Linkazen Aug 29, 2026
72714b7
Fix
Linkazen Aug 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/content/docs/cli-interface.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,11 @@ matching menus depending on your settings.
Reloads the sound theme. This can be useful if you are developing a theme and want to
hear the changes without restarting Kando.
</details>

<details>
<summary>`--config-dir <directory>`</summary>
Specifies the directory to use for the configuration files. Mainly used for development,
as portable mode will allow you to permanently specify a configuration directory.

Both absolute paths (`/path/to/config`) and relative paths (`config`) are supported.
</details>
31 changes: 29 additions & 2 deletions src/content/docs/debugging.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Debugging & Profiling
description: Learn how to debug or profile Kando.
---

import { Aside } from '@astrojs/starlight/components';
import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
import Intro from '../../components/Intro.astro';
import {Image} from 'astro:assets';
import { Icon } from 'astro-icon/components';
Expand Down Expand Up @@ -91,7 +91,7 @@ You can then set breakpoints in your code and inspect variables!
If you are using [Zed](https://zed.dev/), you can set up debugging by editing the `.zed/debug.json` file with `Run > Edit debug.json...`.
Put the following content into that file:

```json5 title=".vscode/launch.json"
```json5 title=".zed/tasks.json"
[
{
"label": "Kando: Main Process",
Expand Down Expand Up @@ -188,3 +188,30 @@ This is extremely useful to identify performance bottlenecks in your code.
<Aside type="tip" title="Need Help?">
If you encounter a problem at any stage, feel free to ask for help in the **#support** or **#dev-chat** channel on [Kando's Discord Server](https://discord.gg/hZwbVSDkhy)!
</Aside>

## <Icon name="solar:document-text-bold-duotone" class="inline-icon" /> Specifying a Custom Configuration Directory
It may be beneficial to specify a custom configuration directory when developing Kando,
this way your main configuration files are not affected by your development changes.

As such, you can specify a custom configuration directory using the <a href="../cli-interface/">`--config-dir`</a> flag when running Kando.

<Tabs syncKey="ide">
<TabItem label="Zed" value="zed" icon="zed">
```json5 title=".zed/tasks.json"
[
{
"label": "Kando: Main Process",
...
"runtimeArgs": [
"node_modules/@electron-forge/cli/src/electron-forge-start",
"--",
"--remote-debugging-port=9223"
"--config-dir=DevConfigFiles"
],
...
},
...
]
```
</TabItem>
</Tabs>
2 changes: 1 addition & 1 deletion src/content/docs/launch-from-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ If you installed Kando via a package manager or via one of the installers from G
When you run Kando from the command line, you can use the [command line interface](/cli-interface) to interact with Kando.
This allows you to open menus, trigger shortcuts, and more.

<LinkCard title="Command Line Interface" description="Click here to learn more about Kando's command line interface." href="/cli-interface"/>
<LinkCard title="Command Line Interface" description="Click here to learn more about Kando's command line interface." href="/cli-interface"/>