CBCRC(4)

πŸ’– CBCRC πŸ’–

okay bestie, so this is a kernel interfaces manual page β€” yes, that's the vibe β€” and it's all about cbcrc, the configuration file for Couchbase command line tools. it lives in section 4. slay. let's get into it ✨


🌸 NAME 🌸

cbcrc β€” configuration file for Couchbase command line tools πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

~/.cbcrc

like, that's the whole synopsis. it's just a file. one file. living its best life in your home directory. iconic πŸ’…


✨ DESCRIPTION ✨

so cbcrc is an optional configuration file that hands out default values to the cbc(1) and cbc-pillowfight(1) utilities. it should be placed in ~/.cbcrc 🏠

each entry in the cbcrc file is one line, and that line is a key-value pair that looks like this:

# optional comments
key=value
and yes, # gives you comments. you can write little notes to yourself. self care πŸ’–

you can put those keys in random order β€” no rules, no alphabetization required, we're not doing that here. and if you specify the same key multiple times? the last value "wins". periodt. πŸ‘‘

here's the full lineup of keys, no gatekeeping:

  • connstr β€” this is the URI-like string you use to connect to the cluster. its format is a scheme, then a list of hosts, then an optional bucket for the path, then an optional ? followed by key-value options. 🫢

using custom REST API ports:

http://localhost:9000,localhost:9001,localhost:9002

using custom memcached ports:

couchbase://localhost:9100,localhost:9200,localhost:9300
  • user β€” this is the user name used during authentication to your bucket πŸ”
  • password β€” this is the password used during authentication to your bucket 🀫
  • timeout β€” the timeout value to use for the operations ⏱️

πŸ’… NOTES πŸ’…

  • you can generate such a file from the cbc(1) itself using the write-config subcommand ✨ (not me letting the tool write its own config, main character energy fr fr)
  • most other options can be specified within the connection string 🌈

πŸ‘‘ SEE ALSO πŸ‘‘

cbc(1), cbc-pillowfight(1)


okay that's the whole page, bestie, and it's giving July 2024 energy from the Kernel Interfaces Manual for CBCRC(4). go forth and configure responsibly πŸ’œπŸ¦‹πŸ’–

πŸ“¦ where this page comes from