NQUIRE(1)

πŸ“¦
version 24.0.20250523 Β· 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

nquire β€” bestie, this is your girl for hitting up NCBI Entrez Utilities, other parameter-based web services, or straight-up FTP. raw queries, no filter ✨

It lives in the NCBI Entrez Direct User's Manual, and we're about to get into it πŸ’…


✨ SYNOPSIS ✨

nquire [-help] [-ftp host dir [file]] [-url URL] [-get [URL]] [-len URL]
       [-lst host dir] [-dir host dir] [-eutils name] [-dwn host dir [file]]
       [-asp host dir [file]]
       [-ncbi|-eutils|-pubchem|-pugrest|-pugview|-datasets] [component ...]
       [-tag value ...] [-examples] [-version]

🌸 DESCRIPTION 🌸

okay so picture this: nquire is out here doing raw HTTP(S) queries against web services β€” think NCBI E-Utilities, the ones that take GET or POST parameters β€” and it can also do downloads or listings from FTP and Aspera servers. πŸ¦‹

heads up bestie: the Aspera thing needs you to install proprietary client software first. not us being dramatic, that's just the deal πŸ™ˆ

πŸŽ€ OPTIONS πŸŽ€

πŸ“– Documentation

  • -help β€” prints usage info, and it comes complete with a few examples too, some of which are extra cute and also show off how to use xtract(1). πŸ‘‘

πŸ” Query Commands

  • -ftp host dir [file] β€” use FTP instead of HTTP, periodt. and here's the tea on the shell implementation: it only accepts a filename on the command line when you invoke it from a (pseudo)terminal. any other time? it reads filenames from standard input. no cap. πŸ’…
  • -url URL β€” the base URL for external search. that's it, that's the whole vibe. ✨
  • -get [URL] β€” makes it use HTTP(S) GET instead of POST. simple as. 🫢
  • -len URL β€” gives you the content length of the HTTP file. iconic for when you just need the numbers. πŸ“
  • -lst host dir β€” lists the contents of an FTP site. window shopping fr fr πŸ›οΈ
  • -dir host dir β€” an FTP listing, but with file sizes included. the receipts, bestie. 🧾

⬇️ File Downloads

  • -dwn host dir [file] β€” literally -ftp energy, except it saves the contents to correspondingly named files in the current directory. so it just... puts them there. slay. πŸ’–
  • -asp host dir [file] β€” same as -dwn, but it uses Aspera's proprietary client if you've got it installed. iykyk πŸ¦‹

πŸ”— -url Shortcuts

these are just preset base URLs, zero thinking required, we love a shortcut:

βž• URL Additions

  • component β€” adds /component onto the base URL. ⚠️ it has to come BEFORE any tag/value pairs, that's the rule, don't fight it. πŸ’…
  • -tag value ... β€” adds &tag=value,... onto the base URL. ⚠️ and this one has to come AFTER any simple components. order matters, bestie, it's giving choreography. 🩰

🧚 Miscellaneous

  • -examples β€” shows you examples of advanced queries. the main character energy of options. πŸ‘‘
  • -version β€” prints the version number. that's it! ⭐

πŸ‘€ SEE ALSO πŸ‘€

archive-nihocc(1), archive-nlmnlp(1), archive-nmcds(1), archive-pids(1), archive-pmc(1), archive-pubmed(1), archive-taxonomy(1), cit2pmid(1), curl(1), download-flatfile(1), download-ncbi-data(1), download-ncbi-software(1), download-pmc(1), download-pubmed(1), ecollect(1), edict(1), efetch(1), efilter(1), einfo(1), elink(1), epost(1), esearch(1), refseq-nm-cds(1), skip-if-file-exists(1), wget(1), xtract(1).


and that's the whole page, bestie 🫢 this one's brought to you by NCBI, dated 2025-05-26 β€” go query something iconic πŸ’–βœ¨

πŸ“¦ where this page comes from