BK-SETUPTOOL(1)

🌸 bk setuptool — the BitKeeper User's Manual, but make it cute 🌸

okay so bestie, welcome to bk setuptool — it's literally a graphical front-end to the BitKeeper setup command, and it's about to hold your hand through making a whole repo. we're in the BitKeeper User's Manual today, so buckle up 🎀

---

✨ SYNOPSIS ✨

bk setuptool [directory]

that's it. that's the whole vibe check. one optional directory, no cap 💅

---

🦋 DESCRIPTION 🦋

so bk setuptool is a graphical interface for creating new BitKeeper repositories. yes, graphical, like, with windows and forms and everything. a glow-up from typing stuff into a terminal, honestly 🫶

the whole point of the tool is to help you enter all the information you need to create a repository, by stepping you through a series of input forms and prompts. it's giving guided tour. it's giving main character energy. it walks you through, one step at a time ✨

you'll be prompted for additional information that gets stored in the config file for the repository. and heads up — different types of repositories will require slightly different sets of data, so don't be surprised if the questions change depending on what you're building 🌈

after all the information has been entered, you get a chance to review everything that's going to be put into the config file before the repository is created. love that for you. a little preview moment, a little "wait, let me check that" — iconic 👑

and then: when the repository is created, the config file is stored as a normal revision controlled file, so you can totally go back and edit the file at a later date. no big deal. it's reversible. we love a reversible situation 💖

now for the big tip — if you're going to be creating several repositories that use the same configuration information (like, say, contact information, the classic), you may create a system-wide default config file at /etc/BitKeeper/etc/config.template. this has the same format as a regular config file. bk setuptool will look for this file and, if found, use the data in the file to set the default values when creating a new repository. so you fill it in once and it's lowkey doing your homework forever 🧚

---

🔥 EXAMPLES 🔥

okay let's say you want to create a repository named /projects/helloworld. you literally type this:

bk setuptool /projects/helloworld

and then it will prompt you for information to place in the config file, and then create a project hierarchy rooted at /projects/helloworld. the config file with all the data you entered ends up at:

/projects/helloworld/BitKeeper/etc/config

slay. a whole repo, just like that 💅

and ngl, you do not need to include the name of a directory on the command line. if you don't include it, you'll be required to enter a name during one of the configuration steps. so like, either way works — the tool's got you 🫶

---

🎀 BINDINGS 🎀

• ENTER — perform the default action, which is either to go to the next step, or create the repository if you're on the final step. one button, two jobs, we stan an efficient queen ✨
• TAB — moves between input fields. hop, hop, hop 🦋

you may also use your system's cut, copy and paste keys in the input fields. yes, all of them. go wild 😭

---

💜 SEE ALSO 💜

• bk-config-etc
• bk-setup

go read those next, iykyk 📚

---

⭐ CATEGORY ⭐

• GUI-tools
• Repository

---

and that's the page, bestie!! 💖 this whole thing was brought to you by BitKeeper Inc — source/version tag 1E1, manual section none, dated as bk setuptool(none) in the footer of the original. no cap, that's the sign-off 🎀✨🦋