BUSTOOLS(1)

πŸŽ€ NAME πŸŽ€

bustools β€” the manual page for bustools 0.45.1, living its best life in the User Commands section of the manual, no cap πŸ’…


✨ SYNOPSIS ✨

bustools <CMD> [arguments] ..

that's it. that's the whole shape of it. a command name, then whatever arguments that command wants, bestie 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so, we're on bustools 0.45.1 and I need you to meet the whole squad. Where <CMD> can be one of:

  • sort β€” sort a BUS file by barcodes and UMIs ✨
  • correct β€” error correct a BUS file πŸ’–
  • umicorrect β€” error correct the UMIs in a BUS file πŸŽ€
  • count β€” generate count matrices from a BUS file πŸ‘‘
  • inspect β€” produce a report summarizing a BUS file πŸ”
  • allowlist β€” generate an on-list from a BUS file 🌸
  • capture β€” capture records from a BUS file 🫢
  • text β€” convert a binary BUS file to a tab-delimited text file πŸ“
  • fromtext β€” convert a tab-delimited text file to a binary BUS file 🌈
  • extract β€” extract FASTQ reads correspnding to reads in BUS file 🧚
  • compress β€” compress a BUS file πŸ’œ
  • decompress β€” decompress a BUSZ (compressed BUS) file πŸ¦‹
  • version β€” prints version number ⭐
  • cite β€” prints citation information πŸ“

and here's the lil tip that saves lives: running bustools <CMD> without arguments prints usage information for <CMD>. like, you don't have to guess, babes, just yell the command name at it and it'll tell you what it wants 😭


πŸ’« Usage: bustools <CMD> [arguments] ..

okay so. and I need you to sit with me on this one. the manpage literally prints the whole thing again. twice. I don't make the rules, I just work here, so here is round two, exactly as written:

Where <CMD> can be one of:

  • sort β€” sort a BUS file by barcodes and UMIs ✨
  • correct β€” error correct a BUS file πŸ’–
  • umicorrect β€” error correct the UMIs in a BUS file πŸŽ€
  • count β€” generate count matrices from a BUS file πŸ‘‘
  • inspect β€” produce a report summarizing a BUS file πŸ”
  • allowlist β€” generate an on-list from a BUS file 🌸
  • capture β€” capture records from a BUS file 🫢
  • text β€” convert a binary BUS file to a tab-delimited text file πŸ“
  • fromtext β€” convert a tab-delimited text file to a binary BUS file 🌈
  • extract β€” extract FASTQ reads correspnding to reads in BUS file 🧚
  • compress β€” compress a BUS file πŸ’œ
  • decompress β€” decompress a BUSZ (compressed BUS) file πŸ¦‹
  • version β€” prints version number ⭐
  • cite β€” prints citation information πŸ“

Running bustools <CMD> without arguments prints usage information for <CMD> β€” yes, again. it said it twice. I said it twice. we are all on the same page now πŸ’€


🌸 SEE ALSO 🌸

The full documentation for bustools is maintained as a Texinfo manual. If the info and bustools programs are properly installed at your site, the command

info bustools

should give you access to the complete manual. go get the extended cut, bestie ✨


and that's the whole vibe check, fr fr. this page is bustools 0.45.1, dated June 2026, and it's chilling in section 1 of the manual as BUSTOOLS(1). slay πŸ«ΆπŸ’–
πŸ“¦ where this page comes from