dominoiq-cli
v1.1.0
Published
Command-line app for sending prompts to a Domino IQ server
Readme
dominoiq-cli
dominoiq-cli is a command-line app for sending prompts to a Domino IQ server using the Domino REST API.
Requirements
- Domino IQ running on a Domino server
- Domino REST API v1.1.4 or newer
- Node.js 18 or newer
Install
npm install -g dominoiq-cliStart the CLI
dominoiq-cliUsage
When the CLI starts, enter slash commands to configure it:
/configsets the Domino REST API URL, for examplehttp://domino-server.com:8880/commandsets the Domino IQcommandto use, for exampleStdReplyEmail/loginprompts for a domino username and password and saves the session/logoutlogs out and clears the session/statusshows the current configuration/versionshows the current app version/helplists all available commands/exitcloses the CLI
Authentication
To send any prompts to Domino IQ, you first need to log in to the Domino REST API with a valid Domino user. Once logged in, your session will remain until the token issued by Domino REST API expires. You can log out using the /logout command to log out of your current session and clear the cached token.
Quickstart
- use the
/configcommand to configure the URL of the Domino REST API - use the
/commandcommand to configure the Domino IQ command to use (e.g 'StdReplyEmail') - use the
/logincommand to log in to the Domino REST API
Then type something to send a prompt to Domino IQ and receive a response.
One-shot usage
You can also submit a single prompt without entering the interactive shell:
dominoiq-cli --prompt "How are things?"
# use a specific Domino IQ command for one-shot mode
dominoiq-cli --prompt "How are things?" --command StdReplyEmailLocal configuration storage
The CLI stores the Domino REST API URL, default command, and Domino REST API JWT in:
%USERPROFILE%\.dominoiq-cli\config.json