> For the complete documentation index, see [llms.txt](https://docs.viesus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viesus.com/support/assistant.md).

# VIESUS Assistant

The VIESUS Assistant is a downloadable **skill** you hand to [Claude](https://claude.com/claude-code) (or another AI agent). It packages the knowledge in this documentation (and more) so the agent can help you to operate or implement VIESUS directly — on your own machine, with your own files and commands.

{% file src="/files/k8hUIcYeHTlJlnn66wWP" %}

***

## In-docs chat vs. the skill

These are two different things:

* **Ask AI** helps you understand VIESUS while you read. Use it for product questions, feature explanations, and quick guidance in the docs.
* **The VIESUS Assistant skill** runs **inside your own agent** (e.g. Claude Code in your terminal). Because it works where your files and tools are, it can also read your `viesusini.json`, run CLI commands, inspect result files, and iterate with you on a real workflow — not just answer questions.

***

## What it helps with

* **Answer VIESUS questions** in plain language, grounded in this documentation.
* **Guide you through installation, licensing, and your first run** for your platform and interface.
* **Build and tune a `viesusini.json` or preset** around your goals, instead of editing JSON by hand.
* **Implement VIESUS in your product or pipeline** — from a simple batch job to a full SaaS integration.
* **Create working commands or config examples** for your environment.
* **Decode errors and exit codes** and suggest the matching fix.
* **Suggest parameter changes** when results need more work.
* **Connect information across the docs** — for example, match a feature to its requirements, limits, configuration switches, and reference pages.

***

## Install & use

The skill is a zip archive containing a main skill file and supporting reference files. Download it, extract it, and make the folder available to your agent.

{% tabs %}
{% tab title="Claude Code" %}

1. Download the zip using the button above.
2. Extract it — you will get a `viesus-skill/` folder.
3. Move the folder into your Claude Code skills directory, for example:

   ```
   ~/.claude/skills/viesus-skill/
   ```
4. Start Claude Code in your project and ask it for help with VIESUS — it will use the skill automatically when relevant.
   {% endtab %}

{% tab title="Claude Desktop" %}

1. Download the zip using the button above.
2. Extract it — you will get a `viesus-skill/` folder.
3. Add the extracted folder to your Claude configuration as a skill source.
4. Ask Claude for help with VIESUS — installing, configuring, or troubleshooting.
   {% endtab %}

{% tab title="Other agents" %}
The skill uses standard skill frontmatter and plain Markdown, so any agent framework that supports skill or instruction folders can load it. Extract the zip and provide the `viesus-skill/` folder to your agent as its VIESUS knowledge source.
{% endtab %}
{% endtabs %}

{% hint style="info" %}
The Assistant gives the best results when it can see your configuration and result files. Run it in the same environment as VIESUS so it can read `viesusini.json`, run commands, and check output.
{% endhint %}

{% hint style="warning" %}
**Experimental.** AI agents can make mistakes. Review every suggestion and keep backups.
{% endhint %}

Please report any bigger issues, problems or important knowledge gaps to [info@viesus.com](mailto:info@viesus.com?subject=VIESUS%20Assistant%20report).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.viesus.com/support/assistant.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
