KCONF2(1)

📦 version 3.0.1.3, in arch rolling, ubuntu resolute, ubuntu stonking

💖 NAME 💖

kconf2 — the KylinSoft configuration management tool. that's it, that's the whole thing, and honestly? iconic. 👑

✨ SYNOPSIS ✨

kconf2 COMMAND [ARGS...]

🦋 DESCRIPTION 🦋

okay so bestie, listen. kconf2 is a command-line tool for managing and manipulating configuration files. that's the job. and it does NOT just sit there — it lets you view, modify, monitor, and reset schema-based configuration items. four whole verbs. we love a multitasker 🫶

basically it's giving "I know exactly what I'm doing and I will tell you everything about your config" energy, and it's right every time. 💅

🌸 COMMANDS 🌸

every single one, no skips, no cuts, we are NOT leaving anyone out 💜

  • help [COMMAND] — show help information. if you pass a COMMAND, it gives you the detailed help for that one specific command. so help alone is the vibe check, help <something> is the deep dive. 🧚
  • list-keys SCHEMA[:VERSION] — lists all the keys in the schema you named. all of them. every last one. 🔑
  • list-children SCHEMA[:VERSION] — lists all the child objects in that schema. the little guys. the descendants. 🍓
  • list-recursively SCHEMA[:VERSION] — goes recursive, listing keys <b>and</b> their values, all the way down. and if you don't give it a SCHEMA? it lists <b>all</b> the keys. unhinged behaviour, honestly obsessed. 😭
  • range SCHEMA[:VERSION] KEY — asks about the range of valid values for that KEY. like, what are this key's acceptable options, bestie. ✨
  • describe SCHEMA[:VERSION] KEY — asks for the description of that KEY. it'll tell you what it is. it's very forthcoming. 📝
  • get SCHEMA[:VERSION] KEY — gets the value of the key. the classic. the one you'll type a million times. 💫
  • set SCHEMA[:VERSION] KEY VALUE — sets the value of the key to VALUE. you're in charge now. main character energy fr fr. 💅
  • reset SCHEMA[:VERSION] KEY — resets the key's value back to its default. factory settings, no hard feelings, we're starting over 🎀
  • writable SCHEMA[:VERSION] KEY — checks whether the key is writable. can you touch it? can you change it? let's find out before you try. 🙈
  • monitor SCHEMA[:VERSION] [KEY] — watches for changes to the KEY. and if you don't give it a KEY, it monitors <b>all</b> the keys in the schema. use ^C to stop monitoring.
lowkey important: ^C is the way out. it will just keep watching forever otherwise, like a very committed little guy 👀
  • reload — reloads the configuration file, and <b>retains user configuration</b>. so it refreshes but keeps your stuff. best of both worlds, we stan. 🔄
  • save PATH — saves your user configuration into the target folder PATH. 🫶
  • list-schemas [APP] [VERSION] — lists the installed schemas. and if you specify APP and VERSION, it only lists the ones that match. filter it, bestie. 🌈

🎀 ARGUMENTS 🎀

what all those little words mean 👇

  • SCHEMA — the name of the schema. yes it's a name. yes it matters. 💜
  • VERSION — specifies the version of the schema. ✨
  • KEY — a key in the schema. 🔑
  • VALUE — the value you want to set. 🍓
  • PATH — the destination folder path. 📁
  • APP — the name of the application. 📱

💅 EXAMPLES 💅

real ones, straight up, use them, they work:

list all keys in a schema — the full roster:

kconf2 list-keys org.example.app

get a configuration value — peek at it:

kconf2 get org.example.app:key1

set a configuration value — change it, periodt:

kconf2 set org.example.app:key1 newvalue

monitor a specific key for changes — keep an eye on it:

kconf2 monitor org.example.app key1

save user configuration — back it up, queen:

kconf2 save /home/user/configs

🌟 AUTHOR 🌟

KylinSoft Co., Ltd. — they made it. give them their flowers 💐

Copyright (C) 2023, KylinSoft Co., Ltd.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

okay that's the whole page, you're fully caught up, no notes 💖 and for the record: this was Version 1.0, 2023, and you just read the KCONF2(1) page. go forth and configure, bestie. you got this. 🎀✨

📦 where this page comes from