diff --git a/src/content/docs/cli-interface.mdx b/src/content/docs/cli-interface.mdx index 67cec4d..1a5110f 100644 --- a/src/content/docs/cli-interface.mdx +++ b/src/content/docs/cli-interface.mdx @@ -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. + +
+ `--config-dir ` + 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. +
diff --git a/src/content/docs/debugging.mdx b/src/content/docs/debugging.mdx index 3dc945d..2d65c57 100644 --- a/src/content/docs/debugging.mdx +++ b/src/content/docs/debugging.mdx @@ -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'; @@ -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", @@ -188,3 +188,30 @@ This is extremely useful to identify performance bottlenecks in your code. + +## 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 `--config-dir` flag when running Kando. + + + + ```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" + ], + ... + }, + ... + ] + ``` + + diff --git a/src/content/docs/launch-from-cli.mdx b/src/content/docs/launch-from-cli.mdx index 0bc2e26..b698f66 100644 --- a/src/content/docs/launch-from-cli.mdx +++ b/src/content/docs/launch-from-cli.mdx @@ -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. - \ No newline at end of file +