open(1)

📦 version 0.4.4, in alpine 3.24

💖 open(1) — bestie's guide to opening (or unlocking) your database 💖

okay so quick vibe check: this is open(1), and it lives in the General Commands Manual section, which is honestly where all the main-character commands hang out. 🎀

✨ NAME ✨

open — opens a new database, or unlocks the existing one. The password may either be prompted for, or may be supplied in a ROOK_PASSWORD environment variable. 🔑

Literally that's the whole thing. Two jobs, one icon. 💅

🌸 SYNOPSIS 🌸

open [--keyfile/-k <string>] [--pin <string>] [--prompt/-P <bool>]
[path(string)]

🦋 DESCRIPTION 🦋

okay so, open opens a new database, or unlocks the existing one. That's it, that's the gig. 👑

The password may either be prompted for, or may be supplied in a ROOK_PASSWORD environment variable. So you've got options, bestie — get asked nicely, or just have the env var already sitting there ready to go. Both valid. Both slay. ✨

💜 OPTIONS 💜

  • --keyfile, -k[=string] — (defaults to "") reads a keyfile from this supplied path. Give it a path, it goes and grabs the keyfile from there. no cap. 📁
  • --pin[=string] — (defaults to "") a one-time pin provided by a previous lock that will re-unlock the database. so like, lock handed you a little key and this is you using it. iconic behavior fr fr 🔓
  • --prompt, -P[=bool] — (defaults to false) prompt for the database password. you want it to ask? set it. you wanna be mysterious with a ROOK_PASSWORD instead? it's already false by default, you're good. 🙈
  • string — (defaults to "") path; full path to the database (the server must be able to find the file). ⚠️ heads up: full path, and the server has to be able to find the file. not you. the server. don't be out here giving it a relative path and then acting surprised, bestie. 😭
reminder that everything's got defaults — "", "", and false — so if you just type open and nothing else, that's a whole valid mood. 🫶

🌈 SEE ALSO 🌈

the whole rook family came to the function, and they all showed up:

rook(1) rook-commands(1) rook-exit(1) rook-help(1) rook-info(1) rook-list(1) rook-lock(1) rook-match(1) rook-open(1) rook-reload(1) rook-search(1) rook-serve(1) rook-show(1) rook-status(1) rook-version(1)

⭐ that's the whole page, go forth and open databases, you gorgeous thing. 🧚

signed off with love from local, dated 2026-05-31 — that's the source/version and date, and honestly? they ate. 👑💖

📦 where this page comes from