branch: externals/ellama
commit 1fd26a56e5f5c51d05608efb840ced9b68f58bd7
Author: Sergey Kostyaev <[email protected]>
Commit: Sergey Kostyaev <[email protected]>
Add blueprints files to the documentation
---
README.org | 11 ++++++++
ellama.info | 92 +++++++++++++++++++++++++++++++++++++------------------------
2 files changed, 67 insertions(+), 36 deletions(-)
diff --git a/README.org b/README.org
index c51399e195..1c46bc2672 100644
--- a/README.org
+++ b/README.org
@@ -379,6 +379,11 @@ argument generated text string.
will work without user confirmation.
- ~ellama-tools-argument-max-length~: Max length of function argument in the
confirmation prompt. Default value 50.
+- ~ellama-blueprint-global-dir~: Global directory for storing blueprint files.
+- ~ellama-blueprint-local-dir~: Local directory name for project-specific
+ blueprints.
+- ~ellama-blueprint-file-extensions~: File extensions recognized as blueprint
+ files.
* Context Management
@@ -623,6 +628,12 @@ Ellama provides several functions to create, select, and
manage blueprints:
from the collection of blueprints. It filters prompts based on whether they
are for developers and their source (user-defined, community, or all).
+** Blueprints files
+
+You can also store blueprints as plain text files. You can store it globally
+inside ~ellama-blueprint-global-dir~ or locally in the project local directory
+~ellama-blueprint-local-dir~ with ~ellama-blueprint-file-extensions~.
+
** Variable Management
Blueprints can include variables that need to be filled before running the chat
diff --git a/ellama.info b/ellama.info
index 31d09b1732..ec605322b7 100644
--- a/ellama.info
+++ b/ellama.info
@@ -101,6 +101,7 @@ Using Blueprints
* Key Components of Ellama Blueprints::
* Creating and Managing Blueprints::
+* Blueprints files::
* Variable Management::
* Keymap and Mode::
* Transient Menus::
@@ -503,6 +504,12 @@ argument generated text string.
this list will work without user confirmation.
• ‘ellama-tools-argument-max-length’: Max length of function argument
in the confirmation prompt. Default value 50.
+ • ‘ellama-blueprint-global-dir’: Global directory for storing
+ blueprint files.
+ • ‘ellama-blueprint-local-dir’: Local directory name for
+ project-specific blueprints.
+ • ‘ellama-blueprint-file-extensions’: File extensions recognized as
+ blueprint files.
File: ellama.info, Node: Context Management, Next: Minor modes, Prev:
Configuration, Up: Top
@@ -813,6 +820,7 @@ for interactions.
* Key Components of Ellama Blueprints::
* Creating and Managing Blueprints::
+* Blueprints files::
* Variable Management::
* Keymap and Mode::
* Transient Menus::
@@ -836,7 +844,7 @@ needed to guide the conversation.
developers.
-File: ellama.info, Node: Creating and Managing Blueprints, Next: Variable
Management, Prev: Key Components of Ellama Blueprints, Up: Using Blueprints
+File: ellama.info, Node: Creating and Managing Blueprints, Next: Blueprints
files, Prev: Key Components of Ellama Blueprints, Up: Using Blueprints
7.2 Creating and Managing Blueprints
====================================
@@ -859,9 +867,20 @@ blueprints:
community, or all).
-File: ellama.info, Node: Variable Management, Next: Keymap and Mode, Prev:
Creating and Managing Blueprints, Up: Using Blueprints
+File: ellama.info, Node: Blueprints files, Next: Variable Management, Prev:
Creating and Managing Blueprints, Up: Using Blueprints
-7.3 Variable Management
+7.3 Blueprints files
+====================
+
+You can also store blueprints as plain text files. You can store it
+globally inside ‘ellama-blueprint-global-dir’ or locally in the project
+local directory ‘ellama-blueprint-local-dir’ with
+‘ellama-blueprint-file-extensions’.
+
+
+File: ellama.info, Node: Variable Management, Next: Keymap and Mode, Prev:
Blueprints files, Up: Using Blueprints
+
+7.4 Variable Management
=======================
Blueprints can include variables that need to be filled before running
@@ -873,7 +892,7 @@ the chat session. Ellama provides command to fill these
variables:
File: ellama.info, Node: Keymap and Mode, Next: Transient Menus, Prev:
Variable Management, Up: Using Blueprints
-7.4 Keymap and Mode
+7.5 Keymap and Mode
===================
Ellama provides a local keymap ‘ellama-blueprint-mode-map’ for managing
@@ -897,7 +916,7 @@ available:
File: ellama.info, Node: Transient Menus, Next: Running Blueprints
programmatically, Prev: Keymap and Mode, Up: Using Blueprints
-7.5 Transient Menus
+7.6 Transient Menus
===================
Ellama includes transient menus for easy access to blueprint commands.
@@ -910,7 +929,7 @@ main menu, providing a comprehensive interface for all
Ellama commands.
File: ellama.info, Node: Running Blueprints programmatically, Prev:
Transient Menus, Up: Using Blueprints
-7.6 Running Blueprints programmatically
+7.7 Running Blueprints programmatically
=======================================
The ‘ellama-blueprint-run’ function initiates a chat session using a
@@ -1471,36 +1490,37 @@ their use in free software.
Tag Table:
Node: Top1379
-Node: Installation3633
-Node: Commands8641
-Node: Keymap16080
-Node: Configuration18913
-Node: Context Management24921
-Node: Transient Menus for Context Management25829
-Node: Managing the Context27443
-Node: Considerations28218
-Node: Minor modes28811
-Node: ellama-context-header-line-mode30799
-Node: ellama-context-header-line-global-mode31624
-Node: ellama-context-mode-line-mode32344
-Node: ellama-context-mode-line-global-mode33192
-Node: Ellama Session Header Line Mode33896
-Node: Enabling and Disabling34465
-Node: Customization34912
-Node: Ellama Session Mode Line Mode35200
-Node: Enabling and Disabling (1)35785
-Node: Customization (1)36232
-Node: Using Blueprints36526
-Node: Key Components of Ellama Blueprints37145
-Node: Creating and Managing Blueprints37752
-Node: Variable Management38733
-Node: Keymap and Mode39202
-Node: Transient Menus40138
-Node: Running Blueprints programmatically40684
-Node: MCP Integration41271
-Node: Acknowledgments42296
-Node: Contributions43008
-Node: GNU Free Documentation License43394
+Node: Installation3654
+Node: Commands8662
+Node: Keymap16101
+Node: Configuration18934
+Node: Context Management25234
+Node: Transient Menus for Context Management26142
+Node: Managing the Context27756
+Node: Considerations28531
+Node: Minor modes29124
+Node: ellama-context-header-line-mode31112
+Node: ellama-context-header-line-global-mode31937
+Node: ellama-context-mode-line-mode32657
+Node: ellama-context-mode-line-global-mode33505
+Node: Ellama Session Header Line Mode34209
+Node: Enabling and Disabling34778
+Node: Customization35225
+Node: Ellama Session Mode Line Mode35513
+Node: Enabling and Disabling (1)36098
+Node: Customization (1)36545
+Node: Using Blueprints36839
+Node: Key Components of Ellama Blueprints37479
+Node: Creating and Managing Blueprints38086
+Node: Blueprints files39064
+Node: Variable Management39485
+Node: Keymap and Mode39938
+Node: Transient Menus40874
+Node: Running Blueprints programmatically41420
+Node: MCP Integration42007
+Node: Acknowledgments43032
+Node: Contributions43744
+Node: GNU Free Documentation License44130
End Tag Table
