Getting Started#
-
Install Enkaidu#
Install using Homebrew (or build from source code).
Binary downloads ComingSoon
-
Install Local LLM Engine#
Install one of the following engines that let you run local LLMs:
If you already have something else that runs an Open AI-compatible chat completion server, that works too.
-
Setup an initial configuration file#
Use the sample config files to get started with LM Studio, Ollama, or Azure OpenAI.
-
Run Enkaidu#
Assuming you installed the
enkaidubinary somewhere on yourPATH, use your terminal / console to go to the directory with yourenkaidu.yamlfile and run the following:enkaiduYou’ll see something like this:
INFO: Reading config file: ./enkaidu.yaml Welcome to Enkaidu 0.x.0 This is your second-in-command(-line) designed to assist you with writing & maintaining code and other text-based content, by enabling LLMs and connecting with MCP servers. When entering a query, • Type /help to see the / commands available. • Press Alt-Enter or Option-Enter to start multi-line editing. INFO: Using model <YOURMODELNAME> INFO: Auto-loading toolsets: DateAndTime INFO: Loaded built-in tools from toolset: get_current_datetime QUERY > -
Your first query#
Ask for the current time, like this:
QUERY > What time is it? CALL get_current_datetime with {} The current date and time is <YOUR CURRENT DATE AND TIME> -
You’re ready!#