KW-INIT(1)

πŸ“¦ version 0.10, in ubuntu stonking

🌸 NAME 🌸

kw-init β€” bestie, this makes the basic config files for kw ✨ (the page title lowkey cuts off at "Create ...asic config files()", but you get the vibe πŸ’…)


πŸ¦‹ SYNOPSIS πŸ¦‹

kw init [--verbose] [--template[=name]]
kw init [--verbose] [--arch <name>][--remote <user>@<ip>:<port>][--target <target>]

πŸ’– DESCRIPTION πŸ’–

okay so. This command creates a .kw folder in your current kernel directory, and inside it you get all the default configuration files. That's the whole thing. πŸŽ€

The primary reason you'd run kw init? It's to pick up freshly created config files. That's it. That's the errand. Go get your fresh files, bestie. 🫢


✨ OPTIONS ✨

  • --template[=name] β€” kw ships with some pre-defined configs for specific targets, and this is how you pick one. If you don't give it any input, kw will show you all the available templates and you literally just pick one yourself. If you do hand it a template name, kw uses that name to create the local config file. Choose your fighter 🧚
  • --arch <arch> β€” sets the arch variable in the newly created build.config file. But wait β€” before it actually changes anything, it checks whether <arch> is a valid architecture that exists in the arch folder of the kernel directory. No fake arches allowed, no cap. πŸ‘‘
  • --remote <user>@<ip>:<port> β€” sets the variables ssh_user, ssh_ip, and ssh_port to <user>, <ip>, and <port> respectively. Three for one, slay. πŸ’…
  • --target <target> β€” sets the variable default_deploy_target from deploy.config to <target>, which can be local or remote. Pick your lane 🌈
  • --verbose β€” verbose mode lets you see the commands being executed under the hood. Main character energy: you get to watch everything happen. πŸ”₯

🌟 EXAMPLES 🌟

For all of these, we're supposing the kernel directory is your current directory. (Ground rules, bestie πŸ“)

For initializing a build.config with arch set to arm, use:

kw init --arch arm

To initialize build.config with arch set to x86 and a kworkflow.config with ssh_user set to john, ssh_ip set to localhost, and ssh_port set to 2222, run:

kw init --arch x86 --remote john@localhost:2222

For initializing a build.config with arch set to arm64, a deploy.config with target set to remote and a kworkflow.config with ssh_user mary, ssh_ip localhost, and ssh_port 1234, run:

kw init --arch arm64 --remote mary@localhost:1234 --target remote

Kw provides some default templates that can be useful for the first setup. Users can see and interactively select the target option by using:

kw init --template

Alternatively, if the user knows which template they want to use:

kw init --template=rpi4-and-5-raspbian-64-cross-x86-arm

Keep in mind that you are still able to combine other parameters with the template feature, for example:

kw init --template=rpi4-and-5-raspbian-64-cross-x86-arm --remote mary@localhost:1234 --target remote

πŸ’œ fr fr that's the whole page. Combine things, vibe with your templates, and may your configs always be freshly created.

okay and that's a wrap on the kw-init page bestie πŸŽ€ the footer is just the title again β€” kw-init - Create ...asic config files() β€” and there's no version or date info to pass along, so I'm giving you this cute sign-off instead. bye, go init something πŸ’–βœ¨

πŸ“¦ where this page comes from