FABRIC(1)

๐Ÿ“ฆ
version 3.2.3 ยท 2 versions
, in ubuntu resolute, ubuntu stonking

๐Ÿ’– FABRIC(1) ๐Ÿ’–

okay so bestie, welcome to the Fabric manual page โ€” yes that Fabric, version 2.6.0, the one from the User Commands section of the man pages. this is your girl's guide to running all the things on all the servers at once, and I'm gonna walk you through every single flag because every single one matters. no skipping. periodt. โœจ


โœจ SYNOPSIS โœจ

fab [--core-opts] task1 [--task1-opts] ... taskN [--taskN-opts]

that's it, that's the whole vibe. you call fab, you hand it some core options, then you stack up your tasks task1 through taskN and each one can have its own little --task1-opts / --taskN-opts situation going on. it's giving layers. it's giving stacked. ๐Ÿซถ


๐ŸŒธ DESCRIPTION ๐ŸŒธ

so the actual rundown lives here, and it's all about the core options โ€” the ones that apply to the whole fab run before any of your tasks even get a say. let's get into it, one icon at a time. ๐Ÿ’…

๐Ÿ”ฅ Core options ๐Ÿ”ฅ

  • --complete โ€” prints out the tab-completion candidates for whatever parse remainder you gave it. like, "what could possibly come next?" energy. ๐Ÿ”ฎ
  • --hide=STRING โ€” sets the default value of run()'s hide kwarg. default vibes, but make them your vibes. ๐Ÿ™ˆ
  • --no-dedupe โ€” turns task deduplication off. no dedupe, no repeats being squashed. ๐Ÿšซ
  • --print-completion-script=STRING โ€” prints the tab-completion script for your preferred shell, and your options are literally bash|zsh|fish. pick your fighter. ๐Ÿš
  • --prompt-for-login-password โ€” asks for an upfront SSH-auth password prompt. get it out of the way early, bestie. ๐Ÿ”
  • --prompt-for-passphrase โ€” same deal but for an upfront SSH key passphrase prompt. ๐Ÿ—๏ธ
  • --prompt-for-sudo-password โ€” prompts the user at the start of the session for the sudo.password config value. front-load that drama. ๐Ÿ‘‘
  • --write-pyc โ€” enables creation of .pyc files. let the bytecode be born. ๐Ÿ
  • -c STRING, --collection=STRING โ€” specify the collection name to load. ๐Ÿ“š
  • -d, --debug โ€” enable debug output. turn the lights all the way up. ๐Ÿ’ก
  • -D INT, --list-depth=INT โ€” when listing tasks, only show the first INT levels. depth control, iconic. ๐ŸŒŠ
  • -e, --echo โ€” echoes executed commands before running them. preview era. ๐Ÿ‘€
  • -f STRING, --config=STRING โ€” the runtime configuration file to use. your config, your rules. ๐Ÿ“
  • -F STRING, --list-format=STRING โ€” changes the display format used when listing tasks. should be one of: flat (default), nested, json. three aesthetics, one flag. โœจ
  • -h [STRING], --help[=STRING] โ€” show core help or per-task help, then exit. the classic. ๐Ÿค
  • -H STRING, --hosts=STRING โ€” comma-separated host name(s) to execute tasks against. tag them all in. ๐ŸŽฏ
  • -i, --identity โ€” path to the runtime SSH identity (key) file. may be given multiple times. stack those identities, queen. ๐Ÿ”‘
  • -l [STRING], --list[=STRING] โ€” list available tasks, optionally limited to a namespace. window shopping for tasks. ๐Ÿ›๏ธ
  • -p, --pty โ€” use a pty when executing shell commands. ๐Ÿ–ฅ๏ธ
  • -r STRING, --search-root=STRING โ€” change the root directory used for finding task modules. relocate the hunt. ๐Ÿ—บ๏ธ
  • -R, --dry โ€” echo commands instead of running them. the safe little rehearsal, bestie. ๐Ÿ™
  • -S STRING, --ssh-config=STRING โ€” path to the runtime SSH config file. โš™๏ธ
  • -t INT, --connect-timeout=INT โ€” specifies the default connection timeout, in seconds. โณ
  • -T INT, --command-timeout=INT โ€” specify a global command execution timeout, in seconds. the big one. ๐Ÿ•ฐ๏ธ
  • -V, --version โ€” show version and exit. ๐Ÿท๏ธ
  • -w, --warn-only โ€” warn, instead of failing, when shell commands fail. soft launch your failures. ๐Ÿซ 
also lowkey important: this build is running with Paramiko 3.5.1 and Invoke 2.2.0. that's the stack, no cap. ๐Ÿ’€

and that's the whole page, bestie!! ๐ŸŽ€ this was Fabric 2.6.0, manual page dated August 2025, and you found it in the User Commands section as FABRIC(1). go forth and fab responsibly. slay. ๐Ÿ’–โœจ๐Ÿฆ‹

๐Ÿ“ฆ where this page comes from