ai_sentinel 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fbc0d9833c0562b188f975fa0d32cb8f175bda40149d1e3c3aa0ec64863f4ad
-  data.tar.gz: 4fb375aa24d1dfa447bf9a52a10f06a03cde84610f75dcdf875cc2aff93b3f97
+  metadata.gz: 4ac43b28f3c4ba7b059a19714ed5f094273527d6f8b534c53823ef6e9f1af09a
+  data.tar.gz: c35e17935d631d41d171f26078320a4d03ccd72848c8fb5990d98b1c8aa6bb7e
 SHA512:
-  metadata.gz: 3516b53aeea1e1175b0d96849a12a3d79ca1ad3c65e91c559f6b746ba2b091f1fd333fe2934abfe14aef82d1da8cc7998a58ca9caba4299332ebd3b226487563
-  data.tar.gz: 9bf82e503bddd8194bf5b492097d507a95e494a48dc9ea4ca2f650638ca48a161e4c50ad922c95495e66d20cd67fb5fd71c23635372c4c5a063223536d34825e
+  metadata.gz: c5a008e3fdc0d2f4e5fbf71c3bb22a02d8b30939fc89b8b29346f8563eaa9440f8f1a1b51a32cf41814998ab47d51cf11f62347cd22d9a120ecab09159bb0395
+  data.tar.gz: ac98856532fee5d16c4873978dca30821bf32cf58e027b1c63c947775ad124c102c2f99f9916c9b62e557664a667695fa0b819b2b7278aa901589c33ebd8d104

data/README.md

@@ -20,6 +20,7 @@ A lightweight Ruby gem for scheduling AI-driven tasks. Define workflows in a YAM
 - [Template interpolation](#template-interpolation)
 - [Conditions](#conditions)
 - [CLI](#cli)
+  - [Daemon mode](#daemon-mode)
 - [Tool use (AI agent autonomy)](#tool-use-ai-agent-autonomy)
   - [How tool use works](#how-tool-use-works)
   - [Available tools](#available-tools)
@@ -106,6 +107,15 @@ bundle exec ai_sentinel version
 
 ### 1. Set your API key
 
+**Option A: In the YAML config** (recommended for headless/embedded systems):
+
+```yaml
+global:
+  api_key: sk-ant-...
+```
+
+**Option B: Via environment variable** (recommended for development):
+
 Create a `.env` file in the directory where you'll run AiSentinel:
 
 ```bash
@@ -116,6 +126,8 @@ echo "ANTHROPIC_API_KEY=sk-ant-..." > .env
 echo "OPENAI_API_KEY=sk-..." > .env
 ```
 
+The YAML `api_key` takes priority. If not set, AiSentinel falls back to the environment variable for the configured provider (`ANTHROPIC_API_KEY` or `OPENAI_API_KEY`).
+
 ### 2. Generate a config file
 
 ```bash
@@ -156,12 +168,13 @@ ai_sentinel validate -c /path/to/my_config.yml
 
 ## Configuration
 
-All configuration is done in `ai_sentinel.yml`. API keys are loaded from environment variables (via `.env` file). **Never put API keys in the YAML config.**
+All configuration is done in `ai_sentinel.yml`. API keys can be set in the YAML config or loaded from environment variables (via `.env` file or shell profile). The YAML `api_key` takes priority over the environment variable.
 
 ### Global settings
 
 ```yaml
 global:
+  api_key: sk-ant-...
   provider: anthropic
   model: claude-sonnet-4-20250514
   database: ./ai_sentinel.sqlite3
@@ -170,6 +183,8 @@ global:
   compaction_threshold: 40
   compaction_buffer: 10
   on_prompt_change: ask
+  working_directory: /opt/etc/ai_sentinel
+  pid_file: /opt/var/run/ai_sentinel.pid
   log_file: ./logs/ai_sentinel.log
   log_file_size: 10485760
   log_files: 5
@@ -189,6 +204,7 @@ global:
 
 | Key | Default | Description |
 |-----|---------|-------------|
+| `api_key` | `nil` | API key for the configured provider. Takes priority over the environment variable. |
 | `provider` | `anthropic` | LLM provider (`anthropic` or `openai`) |
 | `model` | Provider-specific (see below) | Default model for AI steps |
 | `database` | `~/.ai_sentinel/db.sqlite3` | SQLite database path |
@@ -197,6 +213,8 @@ global:
 | `compaction_threshold` | `40` | Message count that triggers automatic context compaction |
 | `compaction_buffer` | `10` | Number of recent messages to keep verbatim after compaction |
 | `on_prompt_change` | `ask` | Action when a prompt template changes (`ask`, `keep`, `drop`) |
+| `working_directory` | `nil` | Working directory for the process. When set, the process `chdir`s to this directory on both `start` and `run`. Affects where relative file paths resolve (logs, database, files created by AI agents, shell command output). |
+| `pid_file` | `~/.ai_sentinel/ai_sentinel.pid` | Path to the PID file written when running in daemon mode (`-d`). |
 | `log_file` | `nil` (STDOUT) | Log file path. When omitted, logs go to STDOUT. |
 | `log_file_size` | `10485760` (10 MB) | Max size per log file before rotation |
 | `log_files` | `5` | Number of rotated log files to keep |
@@ -218,10 +236,7 @@ AiSentinel supports two providers out of the box. Each has sensible defaults:
 global:
   provider: anthropic
   model: claude-sonnet-4-20250514    # optional, this is the default
-```
-
-```bash
-echo "ANTHROPIC_API_KEY=sk-ant-..." > .env
+  api_key: sk-ant-...                # or set ANTHROPIC_API_KEY env var
 ```
 
 #### OpenAI
@@ -230,10 +245,7 @@ echo "ANTHROPIC_API_KEY=sk-ant-..." > .env
 global:
   provider: openai
   model: gpt-4o                      # optional, this is the default
-```
-
-```bash
-echo "OPENAI_API_KEY=sk-..." > .env
+  api_key: sk-...                    # or set OPENAI_API_KEY env var
 ```
 
 #### OpenAI-compatible APIs (Ollama, LM Studio, Azure, etc.)
@@ -481,7 +493,8 @@ String values on the right side can be wrapped in double or single quotes. Numer
 
 ```
 ai_sentinel start                    Start the scheduler
-ai_sentinel start -d                 Start in background mode
+ai_sentinel start -d                 Start in daemon (background) mode
+ai_sentinel stop                     Stop a running daemon
 ai_sentinel run WORKFLOW             Manually trigger a workflow
 ai_sentinel validate                 Validate config file
 ai_sentinel list                     List workflows
@@ -497,9 +510,28 @@ ai_sentinel -v                       Show version
 
 # Use a custom config path (works with any command)
 ai_sentinel start -c path/to/config.yml
+ai_sentinel stop -c path/to/config.yml
 ai_sentinel run my_workflow -c path/to/config.yml
 ```
 
+### Daemon mode
+
+Use `-d` to run AiSentinel as a background daemon:
+
+```bash
+ai_sentinel start -d -c /path/to/config.yml
+```
+
+This detaches the process, writes a PID file (see `pid_file` in [Global settings](#global-settings)), and continues running in the background. Stop it with:
+
+```bash
+ai_sentinel stop -c /path/to/config.yml
+```
+
+The `stop` command reads the PID file, sends a `TERM` signal for graceful shutdown, and cleans up. If the PID file is stale (process already dead), it is removed automatically.
+
+When `working_directory` is configured, the daemon changes to that directory before starting. This controls where relative file paths resolve -- useful for headless systems where the init system may start the process from an unpredictable directory.
+
 ## Tool use (AI agent autonomy)
 
 AiSentinel can give the AI autonomous access to tools, allowing it to perform actions on the local machine as part of responding to a prompt. This is the same mechanism that powers coding assistants like Cursor, Copilot, and opencode -- the AI decides when and how to use tools, and your gem executes them locally.

data/lib/ai_sentinel/config_loader.rb

@@ -8,6 +8,7 @@ module AiSentinel
     VALID_ACTIONS = %w[http_get http_post ai_prompt shell_command].freeze
 
     GLOBAL_CONFIG_MAP = {
+      'api_key' => ->(config, val) { config.api_key = val },
       'provider' => ->(config, val) { config.provider = val.to_sym },
       'model' => ->(config, val) { config.model = val },
       'database' => ->(config, val) { config.database_path = File.expand_path(val) },
@@ -21,7 +22,8 @@ module AiSentinel
       'on_prompt_change' => ->(config, val) { config.on_prompt_change = val.to_sym },
       'tool_safety' => ->(config, val) { config.tool_safety = val.transform_keys(&:to_sym) },
       'max_tool_rounds' => ->(config, val) { config.max_tool_rounds = val },
-      'pid_file' => ->(config, val) { config.pid_file = File.expand_path(val) }
+      'pid_file' => ->(config, val) { config.pid_file = File.expand_path(val) },
+      'working_directory' => ->(config, val) { config.working_directory = File.expand_path(val) }
     }.freeze
 
     attr_reader :config_path, :raw_config

data/lib/ai_sentinel/configuration.rb

@@ -31,7 +31,8 @@ module AiSentinel
     attr_accessor :provider, :api_key, :database_path, :max_context_messages,
                   :compaction_threshold, :compaction_buffer, :log_file,
                   :log_file_size, :log_files, :on_prompt_change,
-                  :tool_safety, :max_tool_rounds, :pid_file
+                  :tool_safety, :max_tool_rounds, :pid_file,
+                  :working_directory
     attr_writer :model, :base_url, :logger
 
     def initialize
@@ -51,6 +52,7 @@ module AiSentinel
       @tool_safety = nil
       @max_tool_rounds = DEFAULT_MAX_TOOL_ROUNDS
       @pid_file = File.join(Dir.home, '.ai_sentinel', 'ai_sentinel.pid')
+      @working_directory = nil
     end
 
     def logger

data/lib/ai_sentinel/scheduler.rb

@@ -13,6 +13,8 @@ module AiSentinel
     end
 
     def start(daemonize: false)
+      apply_working_directory
+
       if daemonize
         Process.daemon(true, true)
         write_pid_file
@@ -36,6 +38,8 @@ module AiSentinel
     end
 
     def trigger(workflow_name)
+      apply_working_directory
+
       workflow = registry[workflow_name.to_s] || registry[workflow_name.to_sym]
       raise Error, "Unknown workflow: #{workflow_name}" unless workflow
 
@@ -49,6 +53,14 @@ module AiSentinel
 
     private
 
+    def apply_working_directory
+      dir = configuration.working_directory
+      return unless dir
+
+      FileUtils.mkdir_p(dir)
+      Dir.chdir(dir)
+    end
+
     def write_pid_file
       FileUtils.mkdir_p(File.dirname(pid_file))
       File.write(pid_file, Process.pid.to_s)

data/lib/ai_sentinel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AiSentinel
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ai_sentinel
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mario Celi