Config JSON Reference

⚙️ config.json Reference

Yonky uses a config.json file to store all script metadata and launcher settings. This page breaks down its structure and usage.

---

📄 File Location

config.json is located in the root directory, next to Yonky.exe.
It is created automatically the first time you add a script via the GUI.

---

🧾 Example Structure

{
  "scripts": [
    {
      "name": "Example Script",
      "description": "Sample PowerShell automation",
      "filename": "example.ps1",
      "timestamp": true
    }
  ],
  "recent_scripts": [],
  "auto_scroll": true,
  "show_timestamps": false,
  "execution_policy": "Bypass"
}

---

🔑 Key Breakdown

scripts

• Type: Array of registered scripts displayed in the GUI.
• Fields:
  • name: Display name for the script in the list.
  • description: Optional short note about the script.
  • filename: Name of the script file in /scripts/ folder.
  • timestamp: true or false — whether output should be timestamped.

⚠️ If you drop a script into /scripts/ manually, it won’t show in the GUI until it’s added here or through the File > Add Script option.

---

recent_scripts

• Type: Array
• Purpose: Tracks recently used scripts (used for future GUI features).

---

auto_scroll

• Type: Boolean (true or false)
• Purpose: If enabled, the output box auto-scrolls during script execution.

---

show_timestamps

• Type: Boolean
• Purpose: Global override to prefix all output lines with a timestamp.

---

execution_policy

• Type: String
• Purpose: Sets PowerShell execution policy at runtime.
• Common values: "Bypass", "RemoteSigned", "Unrestricted"

Useful if your system restricts PowerShell script execution. "Bypass" is safest for most use cases.

---

✏️ Editing Tips

• Always close Yonky before manually editing config.json.
• Use a JSON-aware text editor like VS Code or Notepad++.
• Validate syntax with jsonlint.com if unsure.

---

🛠️ Troubleshooting

• Scripts not showing in GUI: Ensure they are listed under "scripts" and filenames match what's in /scripts/.
• Invalid config: If the file is corrupted, delete it and restart Yonky to generate a fresh one.

---

Feel free to suggest new config keys or improvements via Issues.