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

# Scriban (scriban)

The Scriban project's capability scope, deployment products, integration portals and usage boundaries.

Provides Scriban pure script expression evaluation, suitable for integrating small-scale rules by name and configuring business plugins. A complete getting started example demonstrates service matching using this project.

| Item                  | value                                                                         |
| --------------------- | ----------------------------------------------------------------------------- |
| source code directory | `externals/scriban`                                                           |
| main bag              | `Zongsoft.Externals.Scriban`                                                  |
| Companion theme       | [Scripts and Expressions](/documentation/en/framework/externals/scripting.md) |

## Deployment and Usage Portal

Append the main package to the existing host's [Deployment checklist](/documentation/en/references/deploy-files.md), and retain the plugin list, assembly and ancillary running resources in the package:

{% code title="Application.deploy (append fragment)" %}

```ini
[plugins zongsoft externals scriban]
nuget:Zongsoft.Externals.Scriban
```

{% endcode %}

Match expression evaluator by name `Scriban` after application initialization. The expression uses pure script, such as `x + y`, without directly adding template delimiters.

## Integration Steps

1. First complete the first business plugin tutorial and confirm that the manifest, service registration and commands are all effective.
2. Pass a dictionary of independent variables for each evaluation and verify that numeric or text results are expected.
3. Save rule versions and test inputs to cover missing fields, syntax errors, and illegal results.

For specific configuration, calling examples and related basic concepts, see [Scripts and Expressions](/documentation/en/framework/externals/scripting.md).

## Project Boundaries

{% hint style="info" %}
💡 The current implementation reads variables.Count directly; an empty dictionary should be passed in even if there are no variables. Establishing a context each time does not mean that any script can be security executed or is guaranteed to stop within a specified time.
{% endhint %}

## Further Reading

[Browse extensions by project](/documentation/en/framework/externals/projects.md) · [Scripts and Expressions](/documentation/en/framework/externals/scripting.md) · [source code and project description](https://github.com/Zongsoft/framework/tree/main/externals/scriban)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zongsoft.com/documentation/en/framework/externals/projects/scriban.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.