ESTCALL(1)

📦 version 1.4.13, in fedora 43, fedora 44

💖 NAME 💖

estcall — the command line interface of the node API. she's the group chat between you and a Hyper Estraier node, fr fr 🦋

✨ SYNOPSIS ✨

estcall put [-proxy host port] [-tout num] [-auth user pass] nurl [file]

estcall out [-proxy host port] [-tout num] [-auth user pass] nurl expr

estcall edit [-proxy host port] [-tout num] [-auth user pass] nurl expr name [value]

estcall get [-proxy host port] [-tout num] [-auth user pass] nurl expr [attr]

estcall etch [-proxy host port] [-tout num] [-auth user pass] nurl expr

estcall uriid [-proxy host port] [-tout num] [-auth user pass] nurl uri

estcall inform [-proxy host port] [-tout num] [-auth user pass] [-ia|-iu|-il] nurl

estcall sync [-proxy host port] [-tout num] [-auth user pass] nurl

estcall optimize [-proxy host port] [-tout num] [-auth user pass] nurl

estcall search [-proxy host port] [-tout num] [-auth user pass] [-vx] [-kw] [-ec] [-sf] [-attr expr] [-ord expr] [-max num] [-sk num] [-aux num] [-dis name] [-dpt num] [-mask num] nurl [phrase]

estcall setuser [-proxy host port] [-tout num] [-auth user pass] nurl name mode

estcall setlink [-proxy host port] [-tout num] [-auth user pass] nurl url label credit

estcall raw [-proxy host port] [-tout num] [-auth user pass] [-np] [-eh expr] url [file]

🌈 DESCRIPTION 🌈

okay so estcall isn't one command, she's a whole aggregation of sub commands — like a friend group where everybody has a different job. 💅

The name of the sub command is the first argument. Everything after that gets parsed according to whichever sub command you picked.

Across basically all of them, the shared besties are:

  • nurl — the URL of a node. that's the whole point, that's who you're texting.
  • -proxy host port — the host name and the port number of a proxy server.
  • -tout num — timeout, in seconds.
  • -auth user pass — the user name and the password of authentication information.

🫶 estcall put

estcall put [-proxy host port] [-tout num] [-auth user pass] nurl [file]

Register a document of document draft to a node. ✨

  • file — the target file. If you leave it out, the standard input gets read instead. no file, no problem, just pipe it in bestie.

🎀 estcall out

estcall out [-proxy host port] [-tout num] [-auth user pass] nurl expr

Remove information of a document from a node.

  • expr — the ID number or the URI of a document. either one works, she's flexible like that.

🦋 estcall edit

estcall edit [-proxy host port] [-tout num] [-auth user pass] nurl expr name [value]

Edit an attribute of a document in a node.

  • expr — the ID number or the URI of a document.
  • name — the name of an attribute.
  • value — the value of the attribute. If you omit it, the attribute gets removed. not edited, not blanked — gone. 🙈

🌸 estcall get

estcall get [-proxy host port] [-tout num] [-auth user pass] nurl expr [attr]

Output document draft of a document in a node.

  • expr — the ID number or the URI of a document.
  • attr — if you specify it, only the value of that attribute is output. just the one thing, main character only. 👑

⭐ estcall etch

estcall etch [-proxy host port] [-tout num] [-auth user pass] nurl expr

Output TSV of keywords and their scores of a document in a node.

  • expr — the ID number or the URI of a document.

💜 estcall uriid

estcall uriid [-proxy host port] [-tout num] [-auth user pass] nurl uri

Output the ID number of a document specified by URI.

  • uri — the URI of a document. give her the glow-up name, she gives you back the ID number.

🧚 estcall inform

estcall inform [-proxy host port] [-tout num] [-auth user pass] [-ia|-iu|-il] nurl

Output the name, the label, the number of documents, the number of unique words, and the cache usage of a node. the full stats reveal, iykyk.

  • -ia — names of administrators are output.
  • -iu — names of users are output.
  • -il — expressions of links are output.

🔥 estcall sync

estcall sync [-proxy host port] [-tout num] [-auth user pass] nurl

Synchronize updating contents of the database of a node. get her caught up. 🫶

🌟 estcall optimize

estcall optimize [-proxy host port] [-tout num] [-auth user pass] nurl

Optimize the database of a node. self-care, but for a database.

estcall search [-proxy host port] [-tout num] [-auth user pass] [-vx] [-kw] [-ec] [-sf] [-attr expr] [-ord expr] [-max num] [-sk num] [-aux num] [-dis name] [-dpt num] [-mask num] nurl [phrase]

Search a node for documents. the main event, the whole reason we're here. ✨

  • phrase — the search phrase.
  • -vx — XML including attributes and snippets is output.
  • -kw — keyword vectors are retrieved.
  • -ec — specifies lower limit of similarity eclipse.
  • -sf — the phrase is treated as a simplified form.
  • -attr expr — specifies an attribute search condition. this one can be specified multiple times, stack her up.
  • -ord expr — specifies the order expression. by default, it is descending by score.
  • -max num — the maximum number of show documents. a negative value means unlimited. by default, it is 10.
  • -sk num — the number of documents to be skipped. by default, it is 0.
  • -aux num — permission to adopt result of the auxiliary index. if it is not more than 0, the auxiliary index is not used. by default, it is 32.
  • -dis name — the name of the distinct attribute.
  • -dpt num — the depth of meta search. by default it is 0.
  • -mask num — the mask of meta search. by default it is 0.

💀 estcall setuser

estcall setuser [-proxy host port] [-tout num] [-auth user pass] nurl name mode

Set permission of a user.

  • name — the name of a user.
  • mode — operation mode. 1 means to set the user as an administrator, 2 means to set the user as a guest, and 0 means to revoke the user account. choose wisely bestie, 0 is forever.
estcall setlink [-proxy host port] [-tout num] [-auth user pass] nurl url label credit

Set a link to another node.

  • url — the URL of a destination node.
  • label — the label of the link.
  • credit — the credit of the link. if the value is negative, the link is removed. 💀

🎀 estcall raw

estcall raw [-proxy host port] [-tout num] [-auth user pass] [-np] [-eh expr] url [file]

Output response of an HTTP request. the low-level, no-filter, say-it-with-your-chest option.

  • url — the URL of a target.
  • file — if it's specified, the content is sent by POST method. if not, GET method is used. if - is specified, the standard input is read.
  • -np — output response headers also.
  • -eh expr — specifies an additional HTTP header. by default, Host, Connection, User-Agent, and Content-Length is added.
💖 All sub commands return 0 if the operation is success, else return 1. that's the whole vibe check.

🦋 SEE ALSO 🦋

estconfig(1), estcmd(1), estmaster(1), estwaver(1), estraier(3), estnode(3)

Please see http://hyperestraier.sourceforge.net/nguide-en.html for detail. go read it, she ate. 🔥

okay that's the whole page, no cap. this was ESTCALL(1) from the Hyper Estraier manual, dated 2007-03-06 — shoutout to the Man Page source for keeping the receipts. love u, bye bestie 🫶✨

📦 where this page comes from