docs: added docs for the new .install remote command and functionality

2026-05-22 17:36:54 -06:00
parent a0fda62bb4
commit 4ebf1be271
3 changed files with 20 additions and 1 deletions
+2 -1
@@ -23,6 +23,7 @@ Coming from [AIChat](https://github.com/sigoden/aichat)? Follow the [migration g
* [AIChat Migration Guide](AIChat-Migration): Coming from AIChat? Follow the migration guide to get started.
* [Installation](Installation): Install Loki
* [Getting Started](Getting-Started): Get started with Loki by doing first-run setup steps, and learn the basics.
* [Sharing Configurations](Sharing-Configurations): Install bundles of agents, roles, macros, tools, and MCP servers from any git repo, and share your own.
* [REPL](REPL): Interactive Read-Eval-Print Loop for conversational interactions with LLMs and Loki.
* [Custom REPL Prompt](REPL-Prompt): Customize the REPL prompt to provide useful contextual information.
* [Vault](Vault): Securely store and manage sensitive information such as API keys and credentials.
@@ -54,7 +55,7 @@ Coming from [AIChat](https://github.com/sigoden/aichat)? Follow the [migration g
Loki began as a fork of [AIChat CLI](https://github.com/sigoden/aichat) and has since evolved into an independent project.
See [CREDITS](https://github.com/Dark-Alex-17/loki/CREDITS) for full attribution and background.
See [CREDITS](https://github.com/Dark-Alex-17/loki/CREDITS.md) for full attribution and background.
---
+17
@@ -255,6 +255,23 @@ Loki's own bundled assets are replaced.
(your configured MCP servers and any secret references in them) with Loki's bundled template. The other categories
only overwrite Loki's built-in assets and leave your custom ones alone.
## `.install remote` - Install assets from a git repository
The `.install remote` command installs agents, roles, macros, tools, and MCP servers from any git repository whose
layout mirrors Loki's user config directory. This is the primary mechanism for sharing and reusing Loki configurations.
| Command | Description |
|--------------------------------------------------------------------|------------------------------------------------------------|
| `.install remote <git-url>` | Install everything the repo provides |
| `.install remote <git-url>#<ref>` | Pin to a tag, branch, or commit (e.g. `#v1.0.0`, `#main`) |
| `.install remote <git-url> --filter <category>` | Restrict to one of `agents`, `roles`, `macros`, `functions`, `mcp_config` |
| `.install remote <git-url> --force` | Skip all conflict prompts; overwrite local files unconditionally |
The CLI equivalent is `loki --install-from <git-url>` (with `--filter` and `--install-force` accepting the same values).
See [Sharing Configurations](Sharing-Configurations) for the expected repo layout, conflict resolution, secret handling,
and the [loki-config-template](https://github.com/Dark-Alex-17/loki-config-template) starter you can fork.
## `.update` - Update Loki
The `.update` command updates the Loki binary itself to the latest release,
+1
@@ -2,6 +2,7 @@
- [Home](Home)
- [Installation](Installation)
- [Getting Started](Getting-Started)
- [Sharing Configurations](Sharing-Configurations)
- [AIChat Migration](AIChat-Migration)
## Using Loki