Browse the docs
Reference

npx awaitful reference

Updated July 17, 2026

The complete reference for the Awaitful installer: every command, every flag, and every exit path. It is a small tool on purpose - it detects editors and asks them to install the extension, and that is all it does.

Commands

install (the default)
npx awaitful

Detects your editors and installs the awaitful.awaitful extension from each editor's own marketplace. With several editors found, it asks which one - or all.

check what is installed
npx awaitful status

Prints, per detected editor, the installed Awaitful version or "not installed".

Flags

FlagEffect
--editor <id>Skip the prompt and target one editor: code, cursor, codium, code-insiders.
--allInstall to every detected editor, no prompt.
--dry-runPrint the exact commands it would run, run nothing.
-v, --versionPrint the installer's own version.
-h, --helpUsage.

How detection works

Editors are probed in order - VS Code, Cursor, Devin, VSCodium, VS Code Insiders - first on your PATH, then in the well-known application locations for your platform, each candidate confirmed by asking it for its version. The installer needs Node 18 or newer and tells you plainly if yours is older.

When something is off

  • No editor found - it prints the editors it looked for plus the manual install links (VS Code Marketplace, Open VSX) and exits nonzero.
  • Several editors, no interactive terminal - it asks you to choose with --editor or --all and exits nonzero rather than guessing.
  • Editor installed but not detected - its command line tool is not on your PATH. In VS Code, run "Shell Command: Install 'code' command in PATH" from the Command Palette, then try again.
  • An unexpected crash - it says so honestly ("this looks like a bug in the installer, not in your setup") and points at the issue tracker.

Next step after installing: sign in from the editor, or start from the walkthrough in Install in one command.

Was this page helpful?