101 lines (81 loc) · 8.82 KB

Chat Commands

This article is about:

Available commands during Hatchling chat sessions
Hatch environment and package management commands
Configuration and debugging commands

You will learn about:

How to use basic chat commands for session management
How to manage Hatch environments and packages
How to configure logging and tool settings

The following commands are available during chat:

Basic Commands

Command	Description	Arguments	Example
`help`	Display help for available commands	None	`help`
`clear`	Clear the chat history	None	`clear`
`show_logs`	Display session logs	`[n]` - Optional number of log entries to show	`show_logs` or `show_logs 10`
`set_log_level`	Set the log level	`<level>` - Log level (debug, info, warning, error, critical)	`set_log_level debug`
`version`	Display the current version of Hatchling	None	`version`
`exit` or `quit`	End the chat session	None	`exit`

Hatch Environment Management

Command	Description	Arguments	Example
`hatch:env:list`	List all available Hatch environments	None	`hatch:env:list`
`hatch:env:create`	Create a new Hatch environment	`<name>` - Environment name `--description <description>` - Environment description `--python-version <version>` - Python version `--no-python` - Skip Python env `--no-hatch-mcp-server` - Skip MCP server `--hatch_mcp_server_tag <tag>` - MCP server tag/branch	`hatch:env:create my-env --description "For biology tools"`
`hatch:env:remove`	Remove a Hatch environment	`<name>` - Environment name	`hatch:env:remove my-env`
`hatch:env:current`	Show the current Hatch environment	None	`hatch:env:current`
`hatch:env:use`	Set the current Hatch environment	`<name>` - Environment name	`hatch:env:use my-env`

Python Environment Management

Command	Description	Arguments	Example
`hatch:env:python:init`	Initialize Python environment for a Hatch environment	`--hatch_env <env>` - Hatch environment name `--python-version <version>` - Python version `--force` - Force recreation `--no-hatch-mcp-server` - Skip MCP server `--hatch_mcp_server_tag <tag>` - MCP server tag/branch	`hatch:env:python:init --hatch_env my-env --python-version 3.10`
`hatch:env:python:info`	Show Python environment information	`--hatch_env <env>` - Hatch environment name `--detailed` - Show detailed diagnostics	`hatch:env:python:info --hatch_env my-env --detailed`
`hatch:env:python:remove`	Remove Python environment	`--hatch_env <env>` - Hatch environment name `--force` - Force removal	`hatch:env:python:remove --hatch_env my-env --force`
`hatch:env:python:shell`	Launch Python shell in environment	`--hatch_env <env>` - Hatch environment name `--cmd <command>` - Command to execute	`hatch:env:python:shell --hatch_env my-env --cmd "python --version"`
`hatch:env:python:add-hatch-mcp`	Add hatch_mcp_server wrapper to the environment	`--hatch_env <env>` - Hatch environment name `--tag <tag>` - MCP server tag/branch	`hatch:env:python:add-hatch-mcp --hatch_env my-env --tag v1.2.3`

Hatch Package Management

Command	Description	Arguments	Example
`hatch:pkg:add`	Add a package to an environment	`<package_path_or_name>` - Path or name of package `--env <env_name>` - Environment name `--version <version>` - Package version `--force-download` `--refresh-registry` `--auto-approve`	`hatch:pkg:add ./my-package --env my-env`
`hatch:pkg:remove`	Remove a package from an environment	`<package_name>` - Name of package to remove `--env <env_name>` - Environment name	`hatch:pkg:remove my-package --env my-env`
`hatch:pkg:list`	List packages in an environment	`--env <env_name>` - Environment name	`hatch:pkg:list --env my-env`
`hatch:pkg:create`	Create a new package template	`<name>` - Package name `--dir <dir>` - Target directory `--description <description>` - Package description	`hatch:pkg:create my-package --description "My MCP package"`
`hatch:pkg:validate`	Validate a package	`<package_dir>` - Path to package directory	`hatch:pkg:validate ./my-package`

Settings Management

Command	Description	Arguments	Example
`settings:list`	List all available settings	`[filter]` - Optional filter pattern `--format <format>` - Output format (table, json, yaml)	`settings:list` or `settings:list llm --format json`
`settings:get`	Get the value of a specific setting	`<category:name>` - Setting in format category:name	`settings:get llm:model`
`settings:set`	Set the value of a specific setting	`<category:name> <value>` - Setting and new value `--force-protected` - Force import of protected settings `--force-confirm` - Force application of settings without asking for user consent	`settings:set llm:model mistral-small`
`settings:reset`	Reset a setting to its default value	`<category:name>` - Setting to reset `--force-protected` - Force import of protected settings `--force-confirmed` - Force application of settings without asking for user consent	`settings:reset llm:api_url`
`settings:export`	Export settings to a file	`<file>` - Output file path `--format <format>` - Format (toml, json, yaml) `--all` - Include read-only settings	`settings:export config.toml --format json --all`
`settings:import`	Import settings from a file	`<file>` - Input file path `--force-protected` - Force import of protected settings `--force-confirm` - Force application of settings without asking for user consent	`settings:import config.toml --force-protected`
`settings:save`	Save current settings to the configured file	`--format <format>` - Format (toml, json, yaml)	`settings:save --format toml`

Language Management

Command	Description	Arguments	Example
`settings:language:list`	List available interface languages	None	`settings:language:list`
`settings:language:set`	Set the interface language	`<language_code>` - Language code to set	`settings:language:set fr`

MCP Server and Tool Management Commands

Warning

In development. Commands to connect/disconnect a server, list a server or a tool, an enable/disable tool are stable but UX is poor.

Command	Description	Arguments	Example
`mcp:server:list`	List all MCP servers and their status	None	`mcp:server:list`
`mcp:server:status`	Show detailed status for a specific MCP server	`<server_path>` - Path to the MCP server script	`mcp:server:status /path/to/server.py`
`mcp:server:connect`	Connect to MCP servers	`[server_paths]` - Comma-separated paths to MCP server scripts (optional)	`mcp:server:connect /path/to/server1.py,/path/to/server2.py`
`mcp:server:disconnect`	Disconnect from all MCP servers	None	`mcp:server:disconnect`
`mcp:tool:list`	List all available MCP tools	`[server_path]` - Filter tools by server path (optional)	`mcp:tool:list` or `mcp:tool:list /path/to/server.py`
`mcp:tool:info`	Show detailed information about a specific tool	`<tool_name>` - Name of the tool	`mcp:tool:info my_tool`
`mcp:tool:enable`	Enable a specific MCP tool	`<tool_name>` - Name of the tool to enable	`mcp:tool:enable my_tool`
`mcp:tool:disable`	Disable a specific MCP tool	`<tool_name>` - Name of the tool to disable	`mcp:tool:disable my_tool`
`mcp:health`	Show overall MCP system health summary	None	`mcp:health`

LLM Model and Provider Management Commands

Command	Description	Arguments	Example
`llm:provider:supported`	List all supported LLM providers	None	`llm:provider:supported`
`llm:provider:status`	Check status of a specific provider	`[--provider-name <name>]` - Name of the provider (optional)	`llm:provider:status --provider-name ollama`
`llm:model:list`	List available models	None	`llm:model:list`
`llm:model:add`	Add (download) a model for Ollama; for other providers, check if the model exists online	`<model-name>` - Name of the model `[--provider-name <name>]` - Provider name (optional)	`llm:model:add mistral` or `llm:model:add llama2 --provider-name ollama`
`llm:model:use`	Set the default model to use for the current session	`<model-name>` - Name of the model `[--force-confirmed]` - Force confirmation prompt (optional)	`llm:model:use mistral`
`llm:model:remove`	Remove a model from the list of available models	`<model-name>` - Name of the model	`llm:model:remove mistral`