🤖 Jiro AI Assistant

Your intelligent companion powered by AI and extensible plugins!

🌟 What is Jiro?

Meet Jiro v1.0.0-beta "Kakushin" – your production-ready AI assistant that combines the power of Large Language Models with a robust, extensible plugin system! Whether you need help with daily tasks, want to check the weather, manage conversations, or build custom integrations, Jiro is here to make your life easier and more productive.

✨ What Makes Jiro Special? (v1.0.0-beta "Kakushin")

🧠 AI-Powered Conversations - Leverage LLM intelligence for natural, context-aware interactions
🔌 Plugin Architecture - Extend functionality with custom commands and integrations
🌤️ Built-in Weather - Get real-time weather updates and forecasts
📡 Real-time Log Streaming - Continuous log monitoring with StreamLogsAsync and batch delivery
🔄 Enhanced Session Management - Client-side session ID generation with advanced caching
💬 Multi-Client Support - Web, CLI, and API interfaces with SignalR hub integration
🛡️ Secure & Private - Your data stays secure with robust authentication
🚀 Modern Tech Stack - Built with .NET 9 and modern cloud-native technologies
🐳 Production Ready - Docker profiles with comprehensive environment configuration

🎮 Quick Demo

# Chat with Jiro
You: "What's the weather like today?"
Jiro: "🌤️ It's partly cloudy and 72°F in your area. Perfect for a walk!"

# Get help with commands
You: "/help weather"
Jiro: "Here are the weather commands I can help you with..."

# Custom plugins in action
You: "/net ping google.com"
Jiro: "🌐 Pinging google.com... Response time: 23ms ✅"

🚀 Quick Start

Prerequisites

.NET 9 SDK
Node.js (for the web interface)
OpenAI API Key (optional, for AI chat features)

🏃‍♂️ Get Running in 2 Minutes (Automated Setup)

Clone the repository

git clone https://github.com/HueByte/Jiro.git
cd Jiro

Run the setup script ⚡

# Interactive setup (recommended) - prompts for API keys
./scripts/setup-project.ps1 -Default         # Windows
./scripts/setup-project.sh --default         # Linux/macOS

# OR Non-interactive setup - secure defaults only
./scripts/setup-project.ps1 -NonInteractive  # Windows
./scripts/setup-project.sh --non-interactive # Linux/macOS

Start Jiro

# Option 1: Docker (includes database)
docker-compose up -d

# Option 2: Direct run
cd src/Jiro.Kernel/Jiro.App
dotnet run

Open your browser and navigate to https://jiro.huebytes.com/ 🎉

🔧 Manual Setup (Alternative)

If you prefer manual configuration:

Click to expand manual setup steps

Clone and navigate

git clone https://github.com/HueByte/Jiro.git
cd Jiro

Set up configuration files

# Copy environment template for Docker
cp .env.example .env

# Copy application settings
cd src/Jiro.Kernel/Jiro.App
cp appsettings.example.json appsettings.json

# Copy client app settings
cd clientapp
cp envExamples/.env.example .env
cp envExamples/.env.development.example .env.development

Configure your settings

Edit .env file:

# Required for AI features
OPENAI_API_KEY=sk-your-openai-api-key

# Database configuration
MYSQL_ROOT_PASSWORD=your-root-password
MYSQL_PASSWORD=your-mysql-password

Edit appsettings.json:

{
  "Gpt": {
    "AuthToken": "your-openai-api-key-here"
  },
}

Build and run

cd ../  # Back to Jiro.App directory
dotnet restore src/Main.sln
dotnet build src/Main.sln
dotnet run

🔌 Plugin Development

Want to extend Jiro with your own commands? It's easier than you think!

[Command("hello")]
public class HelloCommand : BaseCommand
{
    public override async Task<string> ExecuteAsync(string[] args)
    {
        var name = args.Length > 0 ? args[0] : "World";
        return $"Hello, {name}! 👋";
    }
}

📚 Learn More: This project demonstrates plugin architecture patterns and extensible command system design

🏗️ Architecture Overview

Jiro is built as a modular, self-contained AI assistant that can run locally while optionally connecting to external services. The architecture follows clean separation of concerns with a focus on extensibility and performance:

%%{init: {
  "theme": "base",
  "themeVariables": {
    "background": "#1C1E26",
    "primaryColor": "#FCD4B8",
    "primaryTextColor": "#D5D8DA",
    "primaryBorderColor": "#E95378",
    "lineColor": "#6C6F93",
    "sectionBkgColor": "#232530",
    "altSectionBkgColor": "#2E303E",
    "gridColor": "#16161C",
    "secondaryColor": "#26BBD9",
    "tertiaryColor": "#27D797",
    "cScale0": "#1C1E26",
    "cScale1": "#232530",
    "cScale2": "#2E303E",
    "cScale3": "#6C6F93",
    "cScale4": "#D5D8DA",
    "clusterBkg": "#232530",
    "clusterBorder": "#6C6F93"
  }
}}%%
graph TB
    subgraph "🌐 External Services"
        JiroCloud[🚀 JiroCloud<br/>Optional Remote Commands]
        OpenAI[🧠 OpenAI API<br/>Language Models]
        WeatherAPI[🌤️ Weather Service<br/>Location & Forecast]
    end

    subgraph "💻 Local Jiro Instance (v1.0.0-beta)"
        subgraph "🎯 Client Layer"
            PythonCLI[🐍 Python CLI<br/>jiro.py]
            WebClient[🌐 Web Interface<br/>SignalR Integration]
            APIClient[📡 API Clients<br/>Multi-Protocol Support]
        end

        subgraph "🚀 Jiro.App Layer"
            JiroApp[🎮 Jiro.App<br/>Main Host Application]
            RestAPI[🌐 REST API<br/>:18090]
            GrpcService[📡 gRPC Service<br/>JiroCloud Integration]
            SignalRHub[🔄 SignalR Hub<br/>Real-time Communication]
        end

        subgraph "💼 Jiro.Core Layer"
            SessionManager[📝 Session Manager<br/>Advanced Caching & Lifecycle]
            MessageCacheService[💾 Message Cache<br/>Performance Optimization]
            LogsProviderService[📊 Logs Provider<br/>Real-time Log Streaming]
            ChatService[💬 Chat Service<br/>LLM Integration]
            CmdSystem[⚡ Command System<br/>Plugin Framework]
            WeatherService[🌤️ Weather Service<br/>Location & Forecasts]
            PersonaService[👤 Persona Service<br/>AI Personality]
            ConversationService[💬 Conversation Service<br/>Context Management]
        end

        subgraph "🗄️ Jiro.Infrastructure Layer"
            EFCore[🗃️ Entity Framework<br/>Data Access]
            Repositories[📊 Repositories<br/>Data Operations]
            Cache[⚡ Memory Cache<br/>Performance]
        end

        subgraph "💾 Storage"
            SQLite[💾 SQLite<br/>Default Database]
            MySQL[🗄️ MySQL<br/>Docker Option]
        end
    end

    subgraph "🔌 Plugin Ecosystem"
        BaseCommands[⚡ Base Commands<br/>Built-in Features]
        CustomPlugins[🔧 Custom Plugins<br/>Extensible via NuGet]
    end

    %% Client to Application Flow
    PythonCLI -->|HTTP Requests| RestAPI
    WebClient -->|SignalR Connection| SignalRHub
    APIClient -->|Multi-Protocol| RestAPI
    RestAPI --> JiroApp
    SignalRHub --> JiroApp

    %% External Service Integration
    JiroApp -.->|Optional| GrpcService
    GrpcService -.->|Commands| JiroCloud
    ChatService -->|LLM Requests| OpenAI
    WeatherService -->|API Calls| WeatherAPI

    %% v1.0.0-beta Core Service Interactions
    JiroApp --> SessionManager
    JiroApp --> MessageCacheService
    JiroApp --> LogsProviderService
    JiroApp --> ChatService
    JiroApp --> CmdSystem
    JiroApp --> WeatherService
    JiroApp --> PersonaService
    JiroApp --> ConversationService

    %% Real-time Features
    LogsProviderService -->|Stream Logs| SignalRHub
    SessionManager -->|Session Events| SignalRHub

    %% Plugin System
    CmdSystem --> BaseCommands
    CmdSystem --> CustomPlugins

    %% Data Layer (v1.0.0-beta)
    SessionManager --> EFCore
    MessageCacheService --> EFCore
    LogsProviderService --> EFCore
    ChatService --> EFCore
    WeatherService --> EFCore
    PersonaService --> EFCore
    ConversationService --> EFCore
    EFCore --> Repositories
    Repositories --> Cache
    EFCore --> SQLite
    EFCore -.->|Docker| MySQL

    %% Horizon Theme Styling with High Contrast Text
    classDef external fill:#FAB795,stroke:#E6A66A,stroke-width:2px,color:#06060C
    classDef client fill:#26BBD9,stroke:#1A9CB8,stroke-width:2px,color:#06060C
    classDef app fill:#FCD4B8,stroke:#E29A6B,stroke-width:2px,color:#06060C
    classDef core fill:#27D797,stroke:#21BFC2,stroke-width:2px,color:#06060C
    classDef infra fill:#6C6F93,stroke:#2E303E,stroke-width:2px,color:#D5D8DA
    classDef storage fill:#2E303E,stroke:#6C6F93,stroke-width:2px,color:#D5D8DA
    classDef plugins fill:#E95378,stroke:#F43E5C,stroke-width:2px,color:#06060C

    class JiroCloud,OpenAI,WeatherAPI external
    class PythonCLI,WebClient,APIClient client
    class JiroApp,RestAPI,GrpcService,SignalRHub app
    class SessionManager,MessageCacheService,LogsProviderService,ChatService,CmdSystem,WeatherService,PersonaService,ConversationService core
    class EFCore,Repositories,Cache infra
    class SQLite,MySQL storage
    class BaseCommands,CustomPlugins plugins

🔧 Architecture Components (v1.0.0-beta "Kakushin")

🚀 Jiro.App - Application Host

Main Host: Central application with dependency injection and configuration
REST API: Primary interface on port 18090 for client communication
gRPC Service: Optional integration with JiroCloud for distributed commands
SignalR Hub: Real-time bidirectional communication for web clients

💡 Jiro.Core - Business Logic (Enhanced)

Session Manager: Advanced session lifecycle management with 5-day caching
Message Cache Service: Performance-optimized message operations
Logs Provider Service: Real-time log streaming with StreamLogsAsync and batch delivery
Chat Service: LLM integration with intelligent conversation management
Command System: Extensible plugin framework for adding new features
Weather Service: Provides location-based weather information
Persona Service: Handles AI personality and behavior customization
Conversation Service: Manages chat context and message history

🏗️ Jiro.Infrastructure - Data Layer

Entity Framework: ORM for database operations and migrations
Repositories: Clean data access patterns with caching support
SQLite: Default lightweight database, MySQL available via Docker

🔌 Plugin Ecosystem

Base Commands: Built-in functionality (chat, weather, etc.)
Custom Plugins: Extensible via NuGet packages and the plugin framework
Dynamic Loading: Runtime discovery and registration of new commands

🌟 Key Architectural Benefits (v1.0.0-beta)

🏠 Self-Contained: Runs completely locally with optional cloud features
🔌 Extensible: Plugin system allows easy addition of new commands
⚡ Performance: Advanced caching, real-time streaming, and efficient data access
🔄 Real-time: SignalR hub integration for instant bidirectional communication
📊 Observability: Real-time log streaming and comprehensive monitoring
🐳 Production Ready: Docker profiles with comprehensive environment configuration
🛡️ Scalable: Multi-service architecture with session management and message caching
📡 Multi-Protocol: gRPC, REST, and WebSocket support for diverse client needs

📚 Documentation

Explore our comprehensive documentation:

📖 User Guide - Get started and learn how to use Jiro
🔧 API Reference - Complete technical documentation
📝 Changelog - What's new in each version

Build Documentation Locally

# Use our handy script
./scripts/docfx-gen.sh        # Linux/macOS
scripts/docfx-gen.ps1         # Windows

# Or manually
cd dev
docfx docfx.json --serve

🐳 Docker Development

Quick Start with Docker

The setup script automatically creates Docker configuration:

# 1. Run the setup script to create .env and config files
./scripts/setup-project.ps1 -Default         # Windows
./scripts/setup-project.sh --default         # Linux/macOS

# 2. Start with Docker Compose (includes MySQL + Jiro Kernel)
docker-compose up -d

# 3. View logs
docker-compose logs -f jiro-kernel

# 4. Stop services
docker-compose down

Environment Configuration

The setup script creates a complete .env file with secure defaults:

# Database Configuration (auto-generated)
MYSQL_ROOT_PASSWORD=secure-generated-password
MYSQL_DATABASE=jiro
MYSQL_USER=jiro
MYSQL_PASSWORD=secure-generated-password
DB_SERVER=mysql

# Application Configuration (auto-generated)
JIRO_ApiKey=secure-generated-api-key
JIRO_JiroApi=https://localhost:5001

# AI Features (configure manually)
OPENAI_API_KEY=your-openai-api-key-here


# Port Configuration
JIRO_HTTP_PORT=8080
JIRO_HTTPS_PORT=8443
JIRO_ADDITIONAL_PORT=18090
MYSQL_PORT=3306

# Data Paths Configuration (optional)
JIRO_DataPaths__Logs=Data/Logs
JIRO_DataPaths__Plugins=Data/Plugins
JIRO_DataPaths__Themes=Data/Themes
JIRO_DataPaths__Messages=Data/Messages

💡 Pro Tip: Use the -Default flag for interactive setup that prompts for your OpenAI API key!

Data Organization

Jiro uses an organized Data folder structure for all application data:

Data/
├── Database/     # SQLite database files
├── Logs/         # Application logs (managed by Serilog)
├── Plugins/      # Plugin assemblies and configurations
├── Themes/       # Custom UI themes and styling
└── Messages/     # Markdown files for chat messages

Docker Volumes: Each Data subfolder has its own persistent volume:

jiro_database → /home/app/jiro/Data/Database
jiro_logs → /home/app/jiro/Data/Logs
jiro_plugins → /home/app/jiro/Data/Plugins
jiro_themes → /home/app/jiro/Data/Themes
jiro_messages → /home/app/jiro/Data/Messages

Path Customization: All paths are configurable via environment variables using the JIRO_DataPaths__ prefix.

🚀 GitHub Container Registry Deployment

Jiro is automatically built and deployed to GitHub Container Registry through our CI/CD pipeline:

Pull Pre-built Images

# Latest stable release
docker pull ghcr.io/huebyte/jiro-kernel:latest

# Specific version
docker pull ghcr.io/huebyte/jiro-kernel:v1.0.0-beta

# Development builds
docker pull ghcr.io/huebyte/jiro-kernel:main

Quick Deploy with GitHub Image

# 1. Create your .env file
cat > .env << 'EOF'
# Required Configuration
MYSQL_ROOT_PASSWORD=secure-root-password
MYSQL_DATABASE=jiro
MYSQL_USER=jiro
MYSQL_PASSWORD=secure-user-password
DB_SERVER=mysql

# Application Configuration
JIRO_ApiKey=your-secure-api-key
JIRO_JiroApi=https://localhost:5001

# AI Features (optional)
OPENAI_API_KEY=sk-your-openai-api-key

# Port Configuration
JIRO_HTTP_PORT=8080
JIRO_HTTPS_PORT=8443
JIRO_ADDITIONAL_PORT=18090
MYSQL_PORT=3306
EOF

# 2. Create docker-compose.yml using GitHub image
cat > docker-compose.yml << 'EOF'
version: '3.8'

services:
  jiro-kernel:
    image: ghcr.io/huebyte/jiro-kernel:latest
    container_name: jiro-kernel
    ports:
      - "${JIRO_HTTP_PORT:-8080}:8080"
      - "${JIRO_HTTPS_PORT:-8443}:8443"
      - "${JIRO_ADDITIONAL_PORT:-18090}:18090"
    environment:
      - ASPNETCORE_ENVIRONMENT=Production
      - ConnectionStrings__JiroContext=Server=${DB_SERVER:-mysql};Database=${MYSQL_DATABASE:-jiro};Uid=${MYSQL_USER:-jiro};Pwd=${MYSQL_PASSWORD};
      - JIRO_ApiKey=${JIRO_ApiKey}
      - JIRO_Chat__AuthToken=${OPENAI_API_KEY}
    volumes:
      - jiro_database:/home/app/jiro/Data/Database
      - jiro_logs:/home/app/jiro/Data/Logs
      - jiro_plugins:/home/app/jiro/Data/Plugins
      - jiro_themes:/home/app/jiro/Data/Themes
      - jiro_messages:/home/app/jiro/Data/Messages
    depends_on:
      mysql:
        condition: service_healthy
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/health"]
      interval: 30s
      timeout: 10s
      retries: 3

  mysql:
    image: mysql:8.0
    container_name: jiro-mysql
    ports:
      - "${MYSQL_PORT:-3306}:3306"
    environment:
      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
      MYSQL_DATABASE: ${MYSQL_DATABASE:-jiro}
      MYSQL_USER: ${MYSQL_USER:-jiro}
      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
    volumes:
      - jiro_mysql_data:/var/lib/mysql
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      timeout: 20s
      retries: 10

volumes:
  jiro_database:
  jiro_logs:
  jiro_plugins:
  jiro_themes:
  jiro_messages:
  jiro_mysql_data:
EOF

# 3. Start the services
docker-compose up -d

# 4. Check logs
docker-compose logs -f jiro-kernel

Available Image Tags

Tag	Description	Auto-Updated
`latest`	Latest stable release	✅ On new releases
`main`	Latest development build	✅ On main branch pushes
`v1.0.0-beta`	Specific version	❌ Static
`pr-123`	Pull request builds	❌ Testing only

Production Deployment

GitHub Container Registry: Official images at ghcr.io/huebyte/jiro-kernel
Automatic Updates: Images built automatically on every release
Multi-architecture: Supports AMD64 and ARM64 architectures
Security Scanning: All images scanned with Trivy for vulnerabilities
Environment Variables: Override .env values for secrets management
Persistent Volumes: All data directories preserved across container restarts
Health Checks: Built-in health monitoring and automatic restart policies

🎓 Engineering Thesis Project

This project is developed as part of an engineering thesis focused on building a modern AI assistant platform. The project demonstrates the integration of AI technologies with clean architecture patterns and modern software engineering practices.

🛠️ Configuration Reference

💡 Note: The setup script automatically configures most settings. This reference is for manual customization.

Setup Script Options

Flag	Description	Best For
`-Default` / `--default`	Interactive setup with prompts	Most users - prompts for API keys
`-NonInteractive` / `--non-interactive`	Secure defaults only	CI/CD - shows what needs manual config

Core API Settings

Setting	Description	Default	Auto-Generated
`urls`	Hosting URLs	`http://localhost:18090;https://localhost:18091`	❌
`Gpt:AuthToken`	OpenAI API key	Required for chat features	❌

Data Paths Settings

Setting	Description	Default	Auto-Generated
`DataPaths:Logs`	Application logs directory	`Data/Logs`	❌
`DataPaths:Plugins`	Plugin assemblies directory	`Data/Plugins`	❌
`DataPaths:Themes`	UI themes directory	`Data/Themes`	❌
`DataPaths:Messages`	Markdown messages directory	`Data/Messages`	❌

Docker Environment Variables

Variable	Description	Auto-Generated
`OPENAI_API_KEY`	OpenAI API key for AI features	❌ (prompted in `-Default` mode)
`MYSQL_ROOT_PASSWORD`	MySQL root password	✅
`MYSQL_PASSWORD`	MySQL user password	✅
`JIRO_ApiKey`	Jiro API authentication key	✅

Web Client Settings

Setting	Description	Default
`PORT`	Development server port	`3000`
`JIRO_API`	API proxy target	`https://localhost:18091`

⚡ Common Issues & Solutions

Setup Issues

Q: Setup script fails with permission error

# Windows
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

# Linux/macOS  
chmod +x scripts/setup-project.sh

Q: OpenAI API key not working

Ensure your API key starts with sk-
Check your OpenAI account has sufficient credits
Verify the key is set in both .env and appsettings.json

Q: Database migration fails

# Reset database
dotnet ef database drop -p src/Jiro.Kernel/Jiro.Infrastructure -s src/Jiro.Kernel/Jiro.App --force
dotnet ef database update -p src/Jiro.Kernel/Jiro.Infrastructure -s src/Jiro.Kernel/Jiro.App

Docker Issues

Q: Docker containers won't start

# Check if ports are available
docker-compose down
docker system prune -f
docker-compose up -d

Q: Can't connect to MySQL in Docker

Ensure .env file has correct MySQL credentials
Wait for MySQL container to fully initialize (30-60 seconds)

Development Commands

# Quick setup for development
./scripts/setup-project.ps1 -Default         # Windows
./scripts/setup-project.sh --default         # Linux/macOS

# Run tests
dotnet test src/Main.sln

# Format code
dotnet format src/Main.sln

# Clean and rebuild
dotnet clean src/Main.sln && dotnet build src/Main.sln

🎯 Roadmap

✅ Released in v1.0.0-beta "Kakushin"

✅ Real-time Log Streaming: StreamLogsAsync with batch delivery
✅ Enhanced Session Management: Advanced caching with 5-day expiration
✅ SignalR Integration: Real-time bidirectional communication
✅ Service Architecture: Separated SessionManager, MessageCacheService, LogsProviderService
✅ Docker Profiles: Multi-profile deployment with comprehensive configuration
✅ GitHub Container Registry: Automated builds and deployments

🔮 Upcoming Features

🧠 Enhanced AI model support (GPT-4, Claude, Gemini, etc.)
📱 Mobile applications (iOS/Android)
🔊 Voice interaction capabilities
🌐 Multi-language support
📊 Advanced analytics and usage insights
🤖 Automated plugin marketplace
🔗 Third-party service integrations (Discord, Slack, Teams, etc.)
🌍 Multi-tenant support for enterprise deployments

💖 Support the Project

If you find this engineering thesis project interesting:

⭐ Star this repository to show your support
🐛 Report issues if you find any bugs
💬 Share feedback on the implementation approach
📚 Check out the documentation in the dev/docs/ folder

📋 Complete Configuration Reference

This table shows all available configuration variables, where they're stored, and their requirements:

Variable Name (Section)	Stored In	Required	Description
Main Application
`ApiKey`	appsettings.json	✅	Main Jiro instance API key
`JIRO_ApiKey`	.env	✅	Main Jiro instance API key (env override)
Chat Configuration
`Chat:AuthToken`	appsettings.json	❌	OpenAI API key for chat features
`Chat:SystemMessage`	appsettings.json	❌	AI assistant personality prompt
`Chat:TokenLimit`	appsettings.json	❌	Maximum tokens per chat response
`Chat:Enabled`	appsettings.json	❌	Enable/disable chat functionality
`JIRO_Chat__AuthToken`	.env	❌	OpenAI API key (env override)
`JIRO_Chat__SystemMessage`	.env	❌	System message (env override)
`JIRO_Chat__TokenLimit`	.env	❌	Token limit (env override)
`JIRO_Chat__Enabled`	.env	❌	Chat enabled flag (env override)
Database Configuration
`ConnectionStrings:JiroContext`	appsettings.json	✅	SQLite connection string
Data Paths
`DataPaths:Logs`	appsettings.json	❌	Application logs directory
`DataPaths:Messages`	appsettings.json	❌	Chat messages storage directory
`DataPaths:Plugins`	appsettings.json	❌	Plugin assemblies directory
`DataPaths:Themes`	appsettings.json	❌	UI themes directory
`JIRO_DataPaths__Logs`	.env	❌	Logs path (env override)
`JIRO_DataPaths__Messages`	.env	❌	Messages path (env override)
`JIRO_DataPaths__Plugins`	.env	❌	Plugins path (env override)
`JIRO_DataPaths__Themes`	.env	❌	Themes path (env override)
JiroCloud Configuration
`JiroCloud:ApiKey`	appsettings.json	✅	JiroCloud API key for cloud services
`JIRO_JiroCloud__ApiKey`	.env	✅	JiroCloud API key (env override)
JiroCloud gRPC
`JiroCloud:Grpc:ServerUrl`	appsettings.json	✅	JiroCloud gRPC server URL
`JiroCloud:Grpc:MaxRetries`	appsettings.json	❌	Maximum gRPC retry attempts
`JiroCloud:Grpc:TimeoutMs`	appsettings.json	❌	gRPC timeout in milliseconds
`JIRO_JiroCloud__Grpc__ServerUrl`	.env	✅	gRPC server URL (env override)
`JIRO_JiroCloud__Grpc__MaxRetries`	.env	❌	Max retries (env override)
`JIRO_JiroCloud__Grpc__TimeoutMs`	.env	❌	Timeout (env override)
JiroCloud WebSocket
`JiroCloud:WebSocket:HubUrl`	appsettings.json	✅	SignalR hub URL
`JiroCloud:WebSocket:HandshakeTimeoutMs`	appsettings.json	❌	WebSocket handshake timeout
`JiroCloud:WebSocket:KeepAliveIntervalMs`	appsettings.json	❌	Keep-alive interval
`JiroCloud:WebSocket:ReconnectionAttempts`	appsettings.json	❌	Max reconnection attempts
`JiroCloud:WebSocket:ReconnectionDelayMs`	appsettings.json	❌	Delay between reconnections
`JiroCloud:WebSocket:ServerTimeoutMs`	appsettings.json	❌	Server timeout
`JIRO_JiroCloud__WebSocket__HubUrl`	.env	✅	Hub URL (env override)
`JIRO_JiroCloud__WebSocket__HandshakeTimeoutMs`	.env	❌	Handshake timeout (env override)
`JIRO_JiroCloud__WebSocket__KeepAliveIntervalMs`	.env	❌	Keep-alive interval (env override)
`JIRO_JiroCloud__WebSocket__ReconnectionAttempts`	.env	❌	Reconnection attempts (env override)
`JIRO_JiroCloud__WebSocket__ReconnectionDelayMs`	.env	❌	Reconnection delay (env override)
`JIRO_JiroCloud__WebSocket__ServerTimeoutMs`	.env	❌	Server timeout (env override)

Configuration Notes

✅ Required: Must be configured for the application to function properly
❌ Optional: Has sensible defaults or is optional functionality
Auto-generated: The setup script automatically generates secure values for API keys
JIRO_ Prefix: All environment variables use the JIRO_ prefix with __ for nested sections
Environment Override: Environment variables take precedence over appsettings.json values

Environment Variable Hierarchy

Environment Variables (highest priority) - JIRO_ prefixed with __ for sections
appsettings.json (fallback) - Standard JSON configuration

Configuration Examples

# Environment variables override appsettings.json
JIRO_Chat__AuthToken=sk-your-openai-key
JIRO_JiroCloud__ApiKey=your-jirocloud-api-key
JIRO_JiroCloud__Grpc__ServerUrl=https://api.jirocloud.com
JIRO_DataPaths__Logs=/custom/logs/path

Setup Script Benefits

Secure Generation: Auto-generates cryptographically secure API keys
Consistent Structure: Ensures both .env and appsettings.json are synchronized
Environment Ready: Creates proper JIRO_ prefixed environment variables

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

🤖 OpenAI for the powerful GPT models
🚀 Microsoft for the amazing .NET ecosystem
❤️ The open-source community for inspiration and support

Ready to meet your new AI assistant? Get Started | Read the Docs | Get Help

Made with ❤️ by HueByte

Name		Name	Last commit message	Last commit date
Latest commit History 445 Commits
.github		.github
assets		assets
dev		dev
scripts		scripts
src		src
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml

License

HueByte/Jiro

Folders and files

Latest commit

History

Repository files navigation

🤖 Jiro AI Assistant

🌟 What is Jiro?

✨ What Makes Jiro Special? (v1.0.0-beta "Kakushin")

🎮 Quick Demo

🚀 Quick Start

Prerequisites

🏃‍♂️ Get Running in 2 Minutes (Automated Setup)

🔧 Manual Setup (Alternative)

🔌 Plugin Development

🏗️ Architecture Overview

🔧 Architecture Components (v1.0.0-beta "Kakushin")

🚀 Jiro.App - Application Host

💡 Jiro.Core - Business Logic (Enhanced)

🏗️ Jiro.Infrastructure - Data Layer

🔌 Plugin Ecosystem

🌟 Key Architectural Benefits (v1.0.0-beta)

📚 Documentation

Build Documentation Locally

🐳 Docker Development

Quick Start with Docker

Environment Configuration

Data Organization

🚀 GitHub Container Registry Deployment

Pull Pre-built Images

Quick Deploy with GitHub Image

Available Image Tags

Production Deployment

🎓 Engineering Thesis Project

🛠️ Configuration Reference

Setup Script Options

Core API Settings

Data Paths Settings

Docker Environment Variables

Web Client Settings

⚡ Common Issues & Solutions

Setup Issues

Docker Issues

Development Commands

🎯 Roadmap

✅ Released in v1.0.0-beta "Kakushin"

🔮 Upcoming Features

💖 Support the Project

📋 Complete Configuration Reference

Configuration Notes

Environment Variable Hierarchy

Configuration Examples

Setup Script Benefits

📄 License

🙏 Acknowledgments

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 10

Uh oh!

Contributors 3

Uh oh!

Languages