Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.heex.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

​
Usage

The llm command allows you to generate LLM instruction files for CLI automation. Usage: 
heex llm [OPTIONS]

​
Available Options

OptionDescription
-h, --helpShow this message and exit.
-of, --output-file FILEPath where to save the instruction file, allowed extensions: [‘md’, ‘json’, ‘yaml’, ‘txt’] [required]

​
Examples

​
Basic Usage

Generate LLM instruction files to a markdown file: 
heex llm --output-file instructions.md

​
Save as JSON

Generate LLM instruction files to a JSON file: 
heex llm --output-file instructions.json

​
Save as YAML

Generate LLM instruction files to a YAML file: 
heex llm --output-file instructions.yaml

​
Save as Text

Generate LLM instruction files to a text file: 
heex llm --output-file instructions.txt
Use this file as instructions for your AI: 
  You are a Heex CLI automation expert.
  Use the knowledge base for complete guidance on Heex CLI automation.
Attach the downloaded file, and you’re ready to go! LLM Knowledge Base

​
Getting Help

heex llm --help