KODEV(1)

✨ NAME ✨

kodev — the Kore project management tool, bestie 💅

---

🌸 SYNOPSIS 🌸

kodev [OPTION] ...

---

💖 DESCRIPTION 💖

okay so this whole page is about the app management tools for building and running a Kore project. that's it, that's the vibe.

if you're here for the technical interface and the C bindings, you want kore(3) instead — that's where all those functions and structures get described. not here. go look. 🫶

Kore projects can be managed with the following OPTIONS, and yes we're going through every single one:

• create — makes a brand new application skeleton with whatever name you hand it. it'll spin up a whole new directory with every file you need to start hacking. the GENERATED FILES section below has the receipts. 🌱
• build — builds the application. more deets in BUILDING. 🔨
• run — starts the application in the foreground, main character style. see RUNNING. 🏃
• reload — reloads the application. it's literally just a shortcut for sending SIGHUP to the parent process (check out kore_pid). 📨
• info — shows you info about the application config, namely: active flavor, output type, Kore features, Kore source and Kore binary. the whole ✨situation✨.
• clean — cleans up the build files. bye bye clutter 🧹
• flavor — switches between build flavors, and the argument you pass is the new flavor. 🍦
• help — shows the help synopsis. when in doubt 💀

---

🎀 GENERATED FILES 🎀

run create and you get a bunch of new files dropped under a directory matching the application name you specified. slay.

These files are:

• conf/build.conf — the build configuration.
• conf/app.conf — the Kore application configuration.
• src/app.c — the initial placeholder source code.
• cert/server.pem — the self-signed auto-generated x509 certificate.
• cert/key.pem — the key matching the self-signed x509 certificate.
• dh2048.pem — the 2048-bit DH parameters used by TLS.

Those files are:

• kore.conf — the Kore application configuration.
• handlers.py — the initial placeholder python page handler.
• __init__.py — the python initialization code. sets up the kore listener, etc.
• cert/server.pem — the self-signed auto-generated x509 certificate.
• cert/key.pem — the key matching the self-signed x509 certificate.
• dh2048.pem — the 2048-bit DH parameters used by TLS.

---

🔥 BUILDING 🔥

running the build command builds your application. how that actually happens is up to the conf/build.conf configuration file. that file supports these directives, and we're listing all of them:

• single_binary [yes|no] — set it to yes and the build system produces a single binary containing both your application code AND the Kore code, so you can distribute your app way more easily. set it to no and you get a standard dynamically linked library that gets loaded into Kore at runtime instead. pick your fighter. 💅
• kore_source [path] — must be set to point to the a Kore source code directory. only used if the single_binary option is set to yes.
  • Example: kore_source=/home/joris/src/kore
• kore_flavor [build options] — defines the build arguments for building Kore. only used if the single_binary option is set to yes.
  • Example: kore_flavor=NOTLS=1
• cflags — standard CFLAGS used when compiling the application source code.
• ldflags — standard LDFLAGS used when linking the application source code.

heads up bestie: the build command obeys the environment variables CC and CXX 👀

---

🌈 RUNNING 🌈

executing the run command starts your application in the foreground. periodt.

which binary it actually executes depends on whether the single_binary flag was set in the build configuration:

• if single_binary was enabled, run executes the binary produced by the build system.
• if single_binary was not enabled, run executes the $PREFIX/bin/kore binary.

and in both cases, the run command passes the -fnr command line options to the binary. every time. no exceptions. ⭐

---

🦋 EXAMPLES 🦋

changing the flavor of the build:

$ kodev flavor osx

building your application:

$ kodev build

---

💀 REPORTING BUGS, CONTRIBUTING && MORE 💀

if you run into any bugs, or you've got suggestions or patches, please contact me at joris@coders.se 🙈

more information can be found at https://kore.io/

---

👑 AUTHOR 👑

Kore developed by Joris Vink joris@coders.se

Manpage authored by Guy Nankivell guynankivell@gmail.com

---

🍓 LICENCE 🍓

usage of this software is provided under the ISC license which may be found, with the source, at https://github.com/jorisvink/kore

---

and that's the whole thing, babes — this was the kodev page from the General Commands Manual (section 1, as the footer confirms 🎀). ty for reading, go build something iconic, mwah 💖✨