KGB-ADD-PROJECT(1p)

📦
version 1.62 · 6 versions
, in ubuntu stonking

💖 KGB-ADD-PROJECT ✨

okay bestie, welcome to kgb-add-project — that's the User Contributed Perl Documentation section 1p, if you're keeping track (and you ARE keeping track, iykyk).

🌸 NAME 🌸

kgb-add-project — it's a lil helper script that adds brand new projects to your kgb-bot configuration file. that's it. that's the job. bestie behaviour honestly 🫶

✨ SYNOPSIS ✨

kgb-add-project [--file configfile] [--dir configdir] [--net|--networks
ircnetwork] [--save|--write] project-id ircchannel password

look at her. three positional args, a handful of flags, and all the power 💅

💜 DESCRIPTION 💜

so <pink>kgb-add-project</pink> lets you add new projects to <hotpink>kgb-bot</hotpink>'s configuration file straight from the command line. no opening files by hand, no vibes-based YAML editing, we're being responsible today.

important though, and I need you to hear me: it writes the new config to stdout unless you pass <purple>--save</purple>|<purple>--write</purple>. so it's giving "peek before you commit" energy. main character move honestly.

🎀 ARGUMENTS 🎀

one bullet per argument, no skips, we don't gatekeep here:

  • --file configfile — optional bestie. defaults to /etc/kgb-bot/kgb.conf.
  • --dir configdir — optional. defaults to /etc/kgb-bot/kgb.conf.d/. this one's the spot for writing config snippets for projects when you've got --save|--write going on.
  • --net|network ircnetwork — optional. defaults to oftc. heads up: it needs to actually live in the <cyan>networks</cyan> section of the configuration file, or it's just a girl standing in front of a network that doesn't exist 😭
  • --save|--write — optional. instead of dumping to stdout, it writes the new config back to the file. very "we're doing this for real" of you.
  • project-id — the project-id to be added. that's the whole thing.
  • irchannel — the IRC channel where your new project sends its messages. here's the cute lil detail: if the channel doesn't already start with a character denoting an IRC channel ("#&+"), then a hash sign gets prepended. so it's got your back. no stress. 🦋
  • password — the password for the new project. guard it like your group chat screenshots 🫣

🌈 EXAMPLE 🌈

go off:

kgb-add-project my-project \#projectchannel RudFiarced0

see how pretty. ate. 👑

💀 CAVEATS 💀

okay now the part where I have to be a real one. two things:

  • kgb-add-project sorts the top-level sections of the configuration file in a fixed order and re-orders the subsections alphabetically. so if you had a beautiful hand-curated ordering situation going on… she's reorganising it. periodt.
  • the output of kgb-add-project does NOT contain the comments that were present in the source configuration file. your little # don't touch this notes? gone. sobbing. back them up if that's a problem for you 🙈

🧚 SEE ALSO 🧚

go read them, they're both iconic in their own way ✨

Copyright (C) 2012 Damyan Ivanov

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

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

anyway that's the whole page, you're fully caught up 💖 this gorgeous little manual was rendered by <pink>perl v5.40.1 on <lavender>2026-07-10, and it's genuinely giving. slay, read safe, and always check stdout before you --save. bye bestie!! 🌸💅🦋

📦 where this page comes from