Zum Inhalt springen

Askimo CLI Commands Reference

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

This document lists all available Askimo commands, their purpose, parameters, and usage examples.

Askimo supports two modes of operation:

Start the interactive shell by running askimo without arguments. Commands use the :keyword format:

Terminal window
askimo
askimo> :help
askimo> :models

Run commands directly from your terminal using the --flag format:

Terminal window
askimo --help
askimo --models
askimo --tools

The following commands work in both interactive (:keyword) and non-interactive (--flag) modes:

  • :help / --help - Show available commands
  • :config / --config - Show current provider, model, and settings
  • :providers / --providers - List all supported model providers
  • :set-provider / --set-provider - Set the current model provider
  • :models / --models - List available models for the current provider
  • :params / --params - Show current model parameters or list available param keys
  • :set-param / --set-param - Set a model parameter
  • :tools / --tools - List all available tools
  • :version / --version - Show detailed version and build information

The following commands are only available in non-interactive mode (CLI flags):

  • --create-recipe - Create a provider-agnostic recipe from a YAML template
  • --recipes - List all registered recipes in ~/.askimo/recipes
  • --delete-recipe - Delete a registered recipe

The following commands are only available in interactive mode:

  • :clear - Clear the current chat memory
  • :copy - Copy the last AI response to the clipboard
  • :sessions - List all saved sessions
  • :new-session - Start a new chat session
  • :resume-session - Resume a previous chat session

Description:
Display all available commands and their short descriptions.

Syntax:

Terminal window
# Interactive mode
:help
# Non-interactive mode
askimo --help

Description:
Clear the chat history for the current session.
This does not reset provider, model, or session parameters - only the conversation context is removed.

Availability: Interactive mode only

Syntax:

Terminal window
:clear

Description:
Copy the last AI response to your system clipboard.
This is useful for quickly pasting the output into another application without manually selecting it.

Availability: Interactive mode only

Syntax:

Terminal window
:copy

Description:
Display the current session parameters, including:

  • Active provider
  • Selected model
  • All configurable parameters available for :set-param / --set-param

Syntax:

Terminal window
# Interactive mode
:params
:params --list
# Non-interactive mode
askimo --params
askimo --params --list

Example:

Terminal window
askimo> :params --list
Available parameter keys for gpt-4o (OPENAI):
model (String) – Model name to use (e.g., gpt-4, llama3)
style (Enum(precise|balanced|creative)) – Output style (determinism vs. creativity)
verbosity (Enum(short|normal|long)) – Controls response length/cost
api_key (String) – OpenAI API key

Notes:

  • The list under “Available parameters” shows what can be changed with :set-param or --set-param
  • Parameter names and defaults may vary depending on the active provider

Description:
Set a parameter for the current AI provider.
Available parameters depend on the provider and can be viewed using :params or --params.

Syntax:

Terminal window
# Interactive mode
:set-param <name> <value>
# Non-interactive mode
askimo --set-param <name> <value>

Parameters:

  • <name> - Name of the parameter (e.g., model, style)
  • <value> - New value to assign to the parameter

Example:

Terminal window
# Interactive mode
askimo> :set-param model gpt-4o
# Non-interactive mode
$ askimo --set-param model gpt-4o

Description:
Display the current Askimo configuration values.

Syntax:

Terminal window
# Interactive mode
:config
# Non-interactive mode
askimo --config

Example:

Terminal window
askimo> :config
🔧 Current configuration:
Provider: OPENAI
Model: gpt-4o
Settings:
apiKey: sk-pr***
presets: Presets(style=BALANCED, verbosity=NORMAL)

Description:
List all AI providers supported by Askimo.

Syntax:

Terminal window
# Interactive mode
:providers
# Non-interactive mode
askimo --providers

Notes:

  • The list may vary depending on your installation and configuration
  • Use :set-provider <name> or askimo --set-provider <name> to switch to one of the available providers

Description:
Switch to a different AI provider for the current session.

Syntax:

Terminal window
# Interactive mode
:set-provider <provider_name>
# Non-interactive mode
askimo --set-provider <provider_name>

Notes:

  • Switching providers may change the available parameters and models
  • After switching, you can use :models or --models to see available models for the new provider

Description:
List all models available for the current provider.
The list is retrieved dynamically based on the active provider’s settings.

Syntax:

Terminal window
# Interactive mode
:models
# Non-interactive mode
askimo --models

Notes:

  • The available models depend on the provider and your local/remote configuration
  • Use :set-param model <model_name> or --set-param model <model_name> to change the active model for the session

Description: Create a provider-agnostic recipe from a YAML template file. Recipes are reusable prompt templates that can be used across different AI providers.

Availability: Non-interactive mode only

Syntax:

Terminal window
askimo --create-recipe [name] -f <file.yml>
askimo --create-recipe [name] -i

Parameters:

  • [name] - Optional name for the recipe (can also be specified in the YAML file)
  • -f, --file - Path to the YAML template file
  • -i, --interactive - Create recipe interactively with guided prompts

Example:

Terminal window
$ askimo --create-recipe myrecipe -f ~/templates/code-review.yml

Notes:

  • If the name is not provided as an argument, it must be specified in the YAML file’s name: field
  • The recipe will be saved to ~/.askimo/recipes/
  • Use askimo -r <recipe-name> to run the recipe from the command line

Description: List all registered recipes stored in ~/.askimo/recipes.

Availability: Non-interactive mode only

Syntax:

Terminal window
askimo --recipes

Example:

Terminal window
$ askimo --recipes
📦 Registered recipes (3)
────────────────────────────
code-review - Review code for bugs and improvements
documentation - Generate documentation for code
refactoring - Suggest refactoring improvements

Description: Delete a registered recipe from ~/.askimo/recipes, or delete all recipes at once.

Availability: Non-interactive mode only

Syntax:

Terminal window
askimo --delete-recipe <name>
askimo --delete-recipe --all

Parameters:

  • <name> - Name of the recipe to delete
  • --all - Delete all registered recipes

Examples:

Terminal window
# Delete a specific recipe
$ askimo --delete-recipe myrecipe
# Delete all recipes
$ askimo --delete-recipe --all

Notes:

  • You will be prompted to confirm the deletion
  • When using --all, you’ll see a list of all recipes before confirmation
  • This operation cannot be undone

Description: List all available tools that can be used in recipes and by the AI agent. This includes tools from GitTools and LocalFsTools.

Syntax:

Terminal window
# Interactive mode
:tools
# Non-interactive mode
askimo --tools

Example:

Terminal window
$ askimo --tools
🔧 Available Tools
──────────────────────────────
📦 GitTools
branch
Current branch name
commit
Write .git/COMMIT_EDITMSG and run git commit -F -
stagedDiff
Unified diff of staged changes (git diff --cached)
status
Concise git status (-sb)
📦 LocalFsTools
readFile
Read text file from path
writeFile
Write text file to path
runCommand
Run shell commands in a persistent terminal...
searchFileContent
Search for text content within files in a directory...
searchFilesByGlob
Search for files by name/pattern with smart matching...
(and more...)
──────────────────────────────
Total: 14 tools

Notes:

  • Tools are organized by their provider class (GitTools, LocalFsTools)
  • Each tool shows its name and description
  • These tools can be invoked by recipes or used by AI agents during code generation

Description: List all saved chat sessions for the current provider and model.

Availability: Interactive mode only

Syntax:

Terminal window
:sessions

Example:

Terminal window
askimo> :sessions
💬 Saved Sessions:
1. [2025-11-06 14:30] Session with 15 messages
2. [2025-11-05 09:15] Session with 8 messages
3. [2025-11-04 16:45] Session with 23 messages

Notes:

  • Sessions are saved automatically during interactive chat
  • Each session is tied to a specific provider and model combination
  • Use :resume-session to continue a previous conversation

Description: Start a new chat session, clearing the current conversation history and creating a fresh context.

Availability: Interactive mode only

Syntax:

Terminal window
:new-session

Example:

Terminal window
askimo> :new-session
Started new session

Notes:

  • This command clears the current conversation context
  • The previous session is saved and can be resumed later with :resume-session
  • Provider, model, and configuration settings are preserved

Description: Resume a previous chat session by selecting from your saved sessions.

Availability: Interactive mode only

Syntax:

Terminal window
:resume-session
:resume-session <session-id>

Parameters:

  • <session-id> - Optional session ID to resume directly

Example:

Terminal window
# Interactive selection
askimo> :resume-session
💬 Saved Sessions:
1. [2025-11-06 14:30] Session with 15 messages
2. [2025-11-05 09:15] Session with 8 messages
Select session to resume [1-2]:
# Direct resume
askimo> :resume-session 1

Notes:

  • If no session ID is provided, you’ll be prompted to select from available sessions
  • Resuming a session loads all previous messages and context
  • Sessions are specific to the provider and model they were created with

Description: Show detailed version and build information for Askimo.

Syntax:

Terminal window
# Interactive mode
:version
# Non-interactive mode
askimo --version