Skip to content

Repository files navigation

Nagient

Nagient

A self-hosted AI agent runtime with controlled tools, pluggable transports, and predictable operations.

Русская версия · User guide · Developer guide · Plugin Hub

Python 3.11 and 3.12Docker imageCIMIT license

Nagient runs an AI agent as an observable service instead of tying it to one terminal session. It keeps configuration, secrets, approvals, logs, updates, and extension lifecycle in one runtime that works on a personal computer or a server.

CapabilityWhat it gives you
Provider freedomBuilt-in OpenAI-compatible providers and a stable contract for external providers.
Controlled toolsBounded filesystem, shell, Git, jobs, configuration, and explicit approval for sensitive actions.
Multiple entry pointsCLI chat, console, webhook, and separately installed transports such as Telegram.
Plugin HubReviewed plugins by short ID, arbitrary Git repositories by URL, isolated dependencies, and visible install status.
Operational runtimePreflight checks, reconciliation, health state, structured logs, Docker Compose, and tag-driven updates.
Portable corePython 3.11+, Linux, macOS, Windows, Docker, and process plugins written in any language.

Quick Install

Linux and macOS

curl -fsSL https://ngnt-in.ruka.me/install.sh | bash
nagient setup

Windows PowerShell

irm https://ngnt-in.ruka.me/install.ps1 | iex
powershell -ExecutionPolicy Bypass -File "$HOME/.nagient/bin/nagient.ps1" setup

Docker Compose on a server

git clone https://github.com/KOSFin/nagient.git
cd nagient
cp .env.example .env
${EDITOR:-vi} .env
docker compose up -d
docker compose exec nagient nagient status

Docker is optional for a source checkout on a personal computer:

bash scripts/install-local.sh --source .export PATH="$HOME/.nagient/bin:$PATH"
nagient setup

Read the installation guide for supported layouts or the server deployment guide for the complete Compose flow.


Getting Started

nagient setup # choose a provider and configure the runtime
nagient chat # start a direct CLI conversation
nagient preflight # validate configuration and plugins
nagient up # start the managed runtime
nagient status # inspect health and activation state
nagient logs # inspect recent runtime logs

Use nagient paths to resolve runtime aliases such as @config, @secrets, @plugins, and @workspace.


Plugin Hub

Telegram and GitHub API integrations are independent plugins, not copies embedded in the core package. Run the installer without arguments to browse verified plugins and see what is already installed:

nagient plugin install

Install a verified plugin by short ID:

nagient plugin install nagient.telegram
nagient plugin install nagient.github_api

Or install any compatible Git repository directly:

nagient plugin install https://github.com/owner/nagient-plugin.git
Verified pluginTypeRepositoryInstall command
Telegram TransportTransportSource and configurationnagient plugin install nagient.telegram
GitHub API ToolToolSource and configurationnagient plugin install nagient.github_api
Plugin TemplateStarterCreate a new pluginUse the repository template

The Plugin Hub guide covers discovery, installation, configuration, updates, trust, and Docker deployment.


How It Fits Together

flowchart LR
U[CLI or transport] --> R[Nagient runtime]
R --> P[Model provider]
R --> A[Approval policy]
A --> T[Built-in tools]
A --> X[External plugins]
R --> S[State and logs]
Loading

The runtime discovers providers, transports, and tools from manifests. External plugins remain under ~/.nagient, so their release cycle and dependencies stay separate from the core.


Documentation

Everything is available in English and Russian. Start with the path that matches what you are trying to do.

SectionArticleWhat it covers
Start hereUser guideThe shortest path from installation to a working agent.
Start hereInstallation and updatesHosted installer, local runtime, upgrade, and removal.
Start hereServer deploymentComplete env-only Docker Compose setup.
Use NagientCommands and daily operationsCLI commands, chat, status, diagnostics, and lifecycle.
Use NagientConfiguration and secretsRuntime files, profiles, aliases, tools, and secret handling.
Use NagientEnvironment variable referenceInstaller, Compose, provider, transport, and plugin variables.
Use NagientTroubleshootingStartup, provider, plugin, Docker, and update failures.
PluginsPlugin Hub and verified catalogFind, install, configure, update, and remove plugins.
PluginsPlugin guide for operatorsPersonal computer and Docker installation workflows.
Build pluginsDeveloper guideEntry point for contributors and plugin authors.
Build pluginsBuild your first pluginTemplate, manifests, packaging, validation, and publishing.
Build pluginsPlugin contractsPython and process runtime protocols.
Build NagientArchitectureBoundaries, dependency policy, runtime flow, and security.
Build NagientTesting and CILocal checks and test layers.
ProjectContributingDevelopment workflow and contribution rules.
ProjectChangelogRelease history and notable changes.

Russian readers can use the complete Russian documentation index.


License

Nagient is released under the MIT License.

About

Легковесный агент для работы с Git, базой знаний и другими инструментами в окне привычных мессенджеров

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages