aias 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.envrc +1 -0
- data/.github/workflows/deploy-github-pages.yml +52 -0
- data/.ruby-version +1 -0
- data/CHANGELOG.md +140 -0
- data/COMMITS.md +196 -0
- data/LICENSE.txt +21 -0
- data/README.md +249 -0
- data/Rakefile +27 -0
- data/aia_schedule_idea.md +256 -0
- data/docs/assets/images/logo.jpg +0 -0
- data/docs/cli/add.md +101 -0
- data/docs/cli/check.md +70 -0
- data/docs/cli/clear.md +45 -0
- data/docs/cli/dry-run.md +57 -0
- data/docs/cli/index.md +51 -0
- data/docs/cli/install.md +198 -0
- data/docs/cli/last.md +49 -0
- data/docs/cli/list.md +40 -0
- data/docs/cli/next.md +49 -0
- data/docs/cli/remove.md +87 -0
- data/docs/cli/show.md +54 -0
- data/docs/cli/uninstall.md +29 -0
- data/docs/cli/update.md +75 -0
- data/docs/getting-started/installation.md +69 -0
- data/docs/getting-started/quick-start.md +105 -0
- data/docs/guides/configuration-layering.md +168 -0
- data/docs/guides/cron-environment.md +112 -0
- data/docs/guides/scheduling-prompts.md +319 -0
- data/docs/guides/understanding-cron.md +134 -0
- data/docs/guides/validation.md +114 -0
- data/docs/index.md +100 -0
- data/docs/reference/api.md +409 -0
- data/docs/reference/architecture.md +122 -0
- data/docs/reference/environment.md +67 -0
- data/docs/reference/logging.md +73 -0
- data/example_prompts/code_health_check.md +51 -0
- data/example_prompts/daily_digest.md +19 -0
- data/example_prompts/morning_standup.md +19 -0
- data/example_prompts/reports/monthly_review.md +44 -0
- data/example_prompts/reports/weekly_summary.md +22 -0
- data/example_prompts/you_are_good.md +22 -0
- data/exe/aias +5 -0
- data/lib/aias/block_parser.rb +42 -0
- data/lib/aias/cli/add.rb +30 -0
- data/lib/aias/cli/check.rb +50 -0
- data/lib/aias/cli/clear.rb +11 -0
- data/lib/aias/cli/dry_run.rb +24 -0
- data/lib/aias/cli/install.rb +57 -0
- data/lib/aias/cli/last.rb +26 -0
- data/lib/aias/cli/list.rb +20 -0
- data/lib/aias/cli/next.rb +28 -0
- data/lib/aias/cli/remove.rb +14 -0
- data/lib/aias/cli/show.rb +18 -0
- data/lib/aias/cli/uninstall.rb +15 -0
- data/lib/aias/cli/update.rb +30 -0
- data/lib/aias/cli/version.rb +10 -0
- data/lib/aias/cli.rb +91 -0
- data/lib/aias/cron_describer.rb +142 -0
- data/lib/aias/crontab_manager.rb +140 -0
- data/lib/aias/env_file.rb +75 -0
- data/lib/aias/job_builder.rb +56 -0
- data/lib/aias/paths.rb +14 -0
- data/lib/aias/prompt_scanner.rb +111 -0
- data/lib/aias/schedule_config.rb +31 -0
- data/lib/aias/validator.rb +101 -0
- data/lib/aias/version.rb +5 -0
- data/lib/aias.rb +17 -0
- data/mkdocs.yml +137 -0
- data/sig/aias.rbs +4 -0
- metadata +191 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 259563157827385f1beba2d991c459efdf4c746a66413bd7ff8d67604d628444
|
|
4
|
+
data.tar.gz: e3ce1c92696ae6875aa5638f1e131d08b90ec50883589bf00ea7b8a2ee47ed2a
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 5fc0091d9f866e3c18853413e5fdcb75d71af405e1bb2828bfa4115bc88d60cf5b1f56082c396cbea5ac89be78f788b17250e9b14951d0af87f0cc91b7c1b3f5
|
|
7
|
+
data.tar.gz: a8d6042f18018b9756d673101a0ed19f6e6bdeea5c95cf2ecc8908e38890fb41ddc802ccf33892150ae75a7c4f4615e3908b2f3208363906566cb4fbb9438197
|
data/.envrc
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export RR=`pwd`
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
name: Deploy Documentation to GitHub Pages
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches:
|
|
5
|
+
- main
|
|
6
|
+
- develop
|
|
7
|
+
paths:
|
|
8
|
+
- "docs/**"
|
|
9
|
+
- "mkdocs.yml"
|
|
10
|
+
- ".github/workflows/deploy-github-pages.yml"
|
|
11
|
+
workflow_dispatch:
|
|
12
|
+
|
|
13
|
+
permissions:
|
|
14
|
+
contents: write
|
|
15
|
+
pages: write
|
|
16
|
+
id-token: write
|
|
17
|
+
|
|
18
|
+
jobs:
|
|
19
|
+
deploy:
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
steps:
|
|
22
|
+
- name: Checkout code
|
|
23
|
+
uses: actions/checkout@v4
|
|
24
|
+
with:
|
|
25
|
+
fetch-depth: 0
|
|
26
|
+
|
|
27
|
+
- name: Setup Python
|
|
28
|
+
uses: actions/setup-python@v5
|
|
29
|
+
with:
|
|
30
|
+
python-version: 3.x
|
|
31
|
+
|
|
32
|
+
- name: Install dependencies
|
|
33
|
+
run: |
|
|
34
|
+
pip install mkdocs
|
|
35
|
+
pip install mkdocs-material
|
|
36
|
+
pip install mkdocs-macros-plugin
|
|
37
|
+
pip install mike
|
|
38
|
+
|
|
39
|
+
- name: Configure Git
|
|
40
|
+
run: |
|
|
41
|
+
git config --local user.email "action@github.com"
|
|
42
|
+
git config --local user.name "GitHub Action"
|
|
43
|
+
|
|
44
|
+
- name: Deploy to GitHub Pages
|
|
45
|
+
run: |
|
|
46
|
+
if [ "${{ github.ref }}" = "refs/heads/main" ]; then
|
|
47
|
+
echo "Deploying from main branch"
|
|
48
|
+
mkdocs gh-deploy --force --clean
|
|
49
|
+
else
|
|
50
|
+
echo "Deploying from develop branch"
|
|
51
|
+
mkdocs gh-deploy --force --clean
|
|
52
|
+
fi
|
data/.ruby-version
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
4.0.2
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# AIAS Change Log
|
|
2
|
+
|
|
3
|
+
The AI Assistant Scheduler
|
|
4
|
+
|
|
5
|
+
## [Unreleased]
|
|
6
|
+
|
|
7
|
+
## [0.1.0] 2026-03-24
|
|
8
|
+
|
|
9
|
+
### refactor(cli): split monolithic CLI into per-command files
|
|
10
|
+
|
|
11
|
+
Moved each of the twelve CLI commands into its own file under
|
|
12
|
+
`lib/aias/cli/` (e.g. `cli/update.rb`, `cli/add.rb`). The main
|
|
13
|
+
`cli.rb` is now a slim skeleton containing shared helpers, map aliases,
|
|
14
|
+
and `require_relative` calls. Zeitwerk is configured to ignore the
|
|
15
|
+
`cli/` subdirectory so the files are loaded explicitly rather than
|
|
16
|
+
autoloaded as constants.
|
|
17
|
+
|
|
18
|
+
Test suite split to match: shared helpers extracted into
|
|
19
|
+
`test/cli_test_case.rb`; each command has its own `test/test_cli_*.rb`
|
|
20
|
+
file. The monolithic `test/test_cli.rb` is removed.
|
|
21
|
+
|
|
22
|
+
### fix(cli): fix `c_l_i` namespace appearing in `aias help` output
|
|
23
|
+
|
|
24
|
+
Thor's `help` instance method takes `subcommand` as a positional
|
|
25
|
+
argument but the override declared it as a keyword argument
|
|
26
|
+
(`subcommand: false`). Ruby passed `{subcommand: false}` — a truthy
|
|
27
|
+
hash — to Thor's positional parameter, causing `formatted_usage` to
|
|
28
|
+
prepend the snake-cased class name (`c_l_i`) to every command in the
|
|
29
|
+
help table. Fixed by changing the signature to match Thor's:
|
|
30
|
+
`def help(command = nil, subcommand = false)`.
|
|
31
|
+
|
|
32
|
+
### feat(cli): add `aias version` command
|
|
33
|
+
|
|
34
|
+
Prints the installed gem version. Accessible as `aias version`,
|
|
35
|
+
`aias -v`, or `aias --version`.
|
|
36
|
+
|
|
37
|
+
### refactor: extract shared modules and classes
|
|
38
|
+
|
|
39
|
+
- `Aias::BlockParser` — shared `extract_block` / `strip_block` helpers
|
|
40
|
+
used by both `CrontabManager` and `EnvFile`; eliminates ~60 lines of
|
|
41
|
+
duplication
|
|
42
|
+
- `Aias::Paths` — single source of truth for all filesystem paths
|
|
43
|
+
(`SCHEDULE_DIR`, `SCHEDULE_CFG`, `SCHEDULE_LOG`, `SCHEDULE_ENV`,
|
|
44
|
+
`AIA_CONFIG`)
|
|
45
|
+
- `Aias::ScheduleConfig` — extracted from `CLI#install`; manages
|
|
46
|
+
`prompts.dir` key in `~/.config/aia/schedule/aia.yml` with full test
|
|
47
|
+
coverage
|
|
48
|
+
|
|
49
|
+
### fix(job_builder): double-quote paths in generated cron entries
|
|
50
|
+
|
|
51
|
+
Paths embedded in cron command strings are now wrapped in double quotes
|
|
52
|
+
inside the single-quoted shell string. Prevents failures when prompts
|
|
53
|
+
directory, log directory, or config file paths contain spaces.
|
|
54
|
+
|
|
55
|
+
### fix(crontab_manager): distinguish missing crontab from read failure
|
|
56
|
+
|
|
57
|
+
`crontab -l` exits non-zero both when the user has no crontab and when
|
|
58
|
+
a real error occurs. `read_crontab` now returns `""` only on the "no
|
|
59
|
+
crontab for" message and raises `Aias::Error` for any other failure,
|
|
60
|
+
preventing silent crontab overwrites on read errors.
|
|
61
|
+
|
|
62
|
+
### fix(prompt_scanner): tighten `grep` invocation
|
|
63
|
+
|
|
64
|
+
Added `--include=*.md` and `-m 1` flags to the `grep -rl` call.
|
|
65
|
+
Limits candidate files to Markdown and stops reading each file after
|
|
66
|
+
the first `schedule:` match, reducing I/O on large prompts directories.
|
|
67
|
+
|
|
68
|
+
### fix(security): create directories with mode 0700, env file with 0600
|
|
69
|
+
|
|
70
|
+
All `FileUtils.mkdir_p` calls now pass `mode: 0o700`. `EnvFile#write`
|
|
71
|
+
applies `chmod 0600` on every write so API keys in `env.sh` are never
|
|
72
|
+
world-readable, even if `umask` is permissive.
|
|
73
|
+
|
|
74
|
+
### docs: rewrite README for CLI users
|
|
75
|
+
|
|
76
|
+
- Removed the "Public API" section (internal Ruby classes belong in the
|
|
77
|
+
full documentation site, not the README)
|
|
78
|
+
- Added "Usage" section with the full `aias help` output
|
|
79
|
+
- Rewrote "How It Works" in user-facing terms; no internal class names
|
|
80
|
+
- Key Features table: stripped per-feature descriptions; names only
|
|
81
|
+
- Added link to full documentation site under the logo
|
|
82
|
+
- CLI Commands table: added `aias version`
|
|
83
|
+
- Fixed stale single-test example (referenced deleted `test_cli.rb`)
|
|
84
|
+
|
|
85
|
+
### docs: update `docs/index.md` to match README structure
|
|
86
|
+
|
|
87
|
+
- Key Features: names only, no inline descriptions
|
|
88
|
+
- Added "Commands" section with full `aias help` output
|
|
89
|
+
- Rewrote "How It Works" in user-facing terms
|
|
90
|
+
|
|
91
|
+
### docs: add "Understanding Cron and Crontab" guide
|
|
92
|
+
|
|
93
|
+
New `docs/guides/understanding-cron.md` for users unfamiliar with cron.
|
|
94
|
+
Covers: what cron is; what a crontab is; reading a five-field cron
|
|
95
|
+
expression; how `aias` owns its block without disturbing other entries;
|
|
96
|
+
why cron strips the environment and how `aias install` solves it;
|
|
97
|
+
essential `crontab` commands; checking job logs; macOS Full Disk Access
|
|
98
|
+
note. Cross-linked from `guides/cron-environment.md`.
|
|
99
|
+
|
|
100
|
+
### feat(cli): add `aias add PATH` command
|
|
101
|
+
|
|
102
|
+
Installs or replaces a single prompt's cron job without touching any other
|
|
103
|
+
installed entries. Useful when you have edited one prompt and want it
|
|
104
|
+
scheduled immediately without re-scanning the entire prompts directory.
|
|
105
|
+
|
|
106
|
+
- `PromptScanner#scan_one(path)` — parses a single file by path; raises
|
|
107
|
+
`Aias::Error` for missing files, files outside the prompts directory, or
|
|
108
|
+
prompts with no `schedule:` in their frontmatter
|
|
109
|
+
- `CrontabManager#add_job(cron_line, prompt_id)` — upserts one entry into
|
|
110
|
+
the aias-managed crontab block; existing entries for the same prompt ID
|
|
111
|
+
are replaced cleanly; all other entries are left untouched
|
|
112
|
+
- Full validation (schedule syntax, parameter defaults, `aia` binary) runs
|
|
113
|
+
before any crontab write, consistent with `aias update`
|
|
114
|
+
|
|
115
|
+
### docs: add `aias add` command documentation
|
|
116
|
+
|
|
117
|
+
- New `docs/cli/add.md` — full command reference with upsert semantics,
|
|
118
|
+
worked examples, prompt ID derivation, options table, and exit codes
|
|
119
|
+
- Updated `docs/cli/index.md` — command count, table row, and
|
|
120
|
+
`--prompts-dir` example
|
|
121
|
+
- Updated `docs/reference/api.md` — `CLI#add`, `PromptScanner#scan_one`,
|
|
122
|
+
and `CrontabManager#add_job` API entries
|
|
123
|
+
- Updated `README.md` — command table, `aias add` section, and Public API
|
|
124
|
+
entries for all three new methods
|
|
125
|
+
|
|
126
|
+
### chore(gemspec): update summary and description
|
|
127
|
+
|
|
128
|
+
- Summary sharpened to lead with the "no config file" differentiator
|
|
129
|
+
- Description rewritten as a `<<~DESC` heredoc covering the full feature
|
|
130
|
+
set: `update`, `add`, schedule formats, runtime model, log location
|
|
131
|
+
|
|
132
|
+
### refactor(prompts): rewrite `code_health_check` example prompt
|
|
133
|
+
|
|
134
|
+
Replaced a passive checklist with an active review prompt that runs
|
|
135
|
+
commands, reads files, and reports findings directly rather than generating
|
|
136
|
+
to-do items for the user to complete manually.
|
|
137
|
+
|
|
138
|
+
## [0.1.0] - 2026-03-23
|
|
139
|
+
|
|
140
|
+
- Initial release
|
data/COMMITS.md
ADDED
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
---
|
|
2
|
+
url: https://www.conventionalcommits.org/en/v1.0.0/
|
|
3
|
+
title: Conventional Commits
|
|
4
|
+
description: A specification for adding human and machine readable meaning to commit messages
|
|
5
|
+
access_date: 2025-07-31T20:51:29.000Z
|
|
6
|
+
current_date: 2025-07-31T20:51:29.601Z
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Conventional Commits
|
|
10
|
+
|
|
11
|
+
A specification for adding human and machine readable meaning to commit messages
|
|
12
|
+
|
|
13
|
+
Quick Summary Full Specification Contribute
|
|
14
|
+
|
|
15
|
+
# Conventional Commits 1.0.0
|
|
16
|
+
|
|
17
|
+
## Summary
|
|
18
|
+
|
|
19
|
+
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
|
|
20
|
+
|
|
21
|
+
The commit message should be structured as follows:
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
<type>[optional scope]: <description>
|
|
27
|
+
|
|
28
|
+
[optional body]
|
|
29
|
+
|
|
30
|
+
[optional footer(s)]
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
The commit contains the following structural elements, to communicate intent to the consumers of your library:
|
|
37
|
+
|
|
38
|
+
1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with `PATCH` in Semantic Versioning).
|
|
39
|
+
2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with `MINOR` in Semantic Versioning).
|
|
40
|
+
3. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with `MAJOR` in Semantic Versioning). A BREAKING CHANGE can be part of commits of any _type_.
|
|
41
|
+
4. _types_ other than `fix:` and `feat:` are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends `build:`, `chore:`,`ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
|
|
42
|
+
5. _footers_ other than `BREAKING CHANGE: <description>` may be provided and follow a convention similar to git trailer format.
|
|
43
|
+
|
|
44
|
+
Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
|
|
45
|
+
|
|
46
|
+
## Examples
|
|
47
|
+
|
|
48
|
+
### Commit message with description and breaking change footer
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
feat: allow provided config object to extend other configs
|
|
52
|
+
|
|
53
|
+
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Commit message with `!` to draw attention to breaking change
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
feat!: send an email to the customer when a product is shipped
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Commit message with scope and `!` to draw attention to breaking change
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
feat(api)!: send an email to the customer when a product is shipped
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Commit message with both `!` and BREAKING CHANGE footer
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
chore!: drop support for Node 6
|
|
75
|
+
|
|
76
|
+
BREAKING CHANGE: use JavaScript features not available in Node 6.
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Commit message with no body
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
docs: correct spelling of CHANGELOG
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Commit message with scope
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
feat(lang): add Polish language
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Commit message with multi-paragraph body and multiple footers
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
fix: prevent racing of requests
|
|
98
|
+
|
|
99
|
+
Introduce a request id and a reference to latest request. Dismiss
|
|
100
|
+
incoming responses other than from latest request.
|
|
101
|
+
|
|
102
|
+
Remove timeouts which were used to mitigate the racing issue but are
|
|
103
|
+
obsolete now.
|
|
104
|
+
|
|
105
|
+
Reviewed-by: Z
|
|
106
|
+
Refs: #123
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Specification
|
|
111
|
+
|
|
112
|
+
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
|
|
113
|
+
|
|
114
|
+
1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed by the OPTIONAL scope, OPTIONAL `!`, and REQUIRED terminal colon and space.
|
|
115
|
+
2. The type `feat` MUST be used when a commit adds a new feature to your application or library.
|
|
116
|
+
3. The type `fix` MUST be used when a commit represents a bug fix for your application.
|
|
117
|
+
4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):`
|
|
118
|
+
5. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_.
|
|
119
|
+
6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
|
|
120
|
+
7. A commit body is free-form and MAY consist of any number of newline separated paragraphs.
|
|
121
|
+
8. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a `:<space>` or `<space>#` separator, followed by a string value (this is inspired by the git trailer convention).
|
|
122
|
+
9. A footer’s token MUST use `-` in place of whitespace characters, e.g., `Acked-by` (this helps differentiate the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token.
|
|
123
|
+
10. A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
|
|
124
|
+
11. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
|
|
125
|
+
12. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g.,_BREAKING CHANGE: environment variables now take precedence over config files_.
|
|
126
|
+
13. If included in the type/scope prefix, breaking changes MUST be indicated by a`!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
|
|
127
|
+
14. Types other than `feat` and `fix` MAY be used in your commit messages, e.g., _docs: update ref docs._
|
|
128
|
+
15. The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
|
|
129
|
+
16. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.
|
|
130
|
+
|
|
131
|
+
## Why Use Conventional Commits
|
|
132
|
+
|
|
133
|
+
* Automatically generating CHANGELOGs.
|
|
134
|
+
* Automatically determining a semantic version bump (based on the types of commits landed).
|
|
135
|
+
* Communicating the nature of changes to teammates, the public, and other stakeholders.
|
|
136
|
+
* Triggering build and publish processes.
|
|
137
|
+
* Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.
|
|
138
|
+
|
|
139
|
+
## FAQ
|
|
140
|
+
|
|
141
|
+
### How should I deal with commit messages in the initial development phase?
|
|
142
|
+
|
|
143
|
+
We recommend that you proceed as if you’ve already released the product. Typically _somebody_, even if it’s your fellow software developers, is using your software. They’ll want to know what’s fixed, what breaks etc.
|
|
144
|
+
|
|
145
|
+
### Are the types in the commit title uppercase or lowercase?
|
|
146
|
+
|
|
147
|
+
Any casing may be used, but it’s best to be consistent.
|
|
148
|
+
|
|
149
|
+
### What do I do if the commit conforms to more than one of the commit types?
|
|
150
|
+
|
|
151
|
+
Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
|
|
152
|
+
|
|
153
|
+
### Doesn’t this discourage rapid development and fast iteration?
|
|
154
|
+
|
|
155
|
+
It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
|
|
156
|
+
|
|
157
|
+
### Might Conventional Commits lead developers to limit the type of commits they make because they’ll be thinking in the types provided?
|
|
158
|
+
|
|
159
|
+
Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
|
|
160
|
+
|
|
161
|
+
### How does this relate to SemVer?
|
|
162
|
+
|
|
163
|
+
`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
|
|
164
|
+
|
|
165
|
+
### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
|
|
166
|
+
|
|
167
|
+
We recommend using SemVer to release your own extensions to this specification (and encourage you to make these extensions!)
|
|
168
|
+
|
|
169
|
+
### What do I do if I accidentally use the wrong commit type?
|
|
170
|
+
|
|
171
|
+
#### When you used a type that’s of the spec but not the correct type, e.g. `fix` instead of `feat`
|
|
172
|
+
|
|
173
|
+
Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
|
|
174
|
+
|
|
175
|
+
#### When you used a type _not_ of the spec, e.g. `feet` instead of `feat`
|
|
176
|
+
|
|
177
|
+
In a worst case scenario, it’s not the end of the world if a commit lands that does not meet the Conventional Commits specification. It simply means that commit will be missed by tools that are based on the spec.
|
|
178
|
+
|
|
179
|
+
### Do all my contributors need to use the Conventional Commits specification?
|
|
180
|
+
|
|
181
|
+
No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they’re merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
|
|
182
|
+
|
|
183
|
+
### How does Conventional Commits handle revert commits?
|
|
184
|
+
|
|
185
|
+
Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release instead be a patch?
|
|
186
|
+
|
|
187
|
+
Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling authors to use the flexibility of _types_ and _footers_ to develop their logic for handling reverts.
|
|
188
|
+
|
|
189
|
+
One recommendation is to use the `revert` type, and a footer that references the commit SHAs that are being reverted:
|
|
190
|
+
|
|
191
|
+
```
|
|
192
|
+
revert: let us never again speak of the noodle incident
|
|
193
|
+
|
|
194
|
+
Refs: 676104e, a215868
|
|
195
|
+
|
|
196
|
+
```
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Dewayne VanHoozer
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
# aias - AI Assistant (AIA) Scheduler
|
|
2
|
+
|
|
3
|
+
> [!INFO]
|
|
4
|
+
> See the [CHANGELOG](CHANGELOG.md) for the latest changes.
|
|
5
|
+
|
|
6
|
+
<br>
|
|
7
|
+
<table>
|
|
8
|
+
<tr>
|
|
9
|
+
<td width="40%" align="center" valign="top">
|
|
10
|
+
<img src="docs/assets/images/logo.jpg" alt="aias"><br>
|
|
11
|
+
<em>"Schedule. Batch. Execute."</em><br><br>
|
|
12
|
+
<a href="https://madbomber.github.io/aias">Full Documentation</a>
|
|
13
|
+
</td>
|
|
14
|
+
<td width="60%" valign="top">
|
|
15
|
+
<h2>Key Features</h2>
|
|
16
|
+
|
|
17
|
+
- Natural Language Scheduling
|
|
18
|
+
- Zero Configuration
|
|
19
|
+
- Reliable Cron Environment
|
|
20
|
+
- MCP Server Support
|
|
21
|
+
- Per-Prompt Overrides
|
|
22
|
+
- Schedule-Specific Config
|
|
23
|
+
- Single-Prompt Control
|
|
24
|
+
- Full Sync on Update
|
|
25
|
+
- Safe Validation
|
|
26
|
+
- Rich Inspection Commands
|
|
27
|
+
</td>
|
|
28
|
+
</tr>
|
|
29
|
+
</table>
|
|
30
|
+
|
|
31
|
+
Schedule [AIA](https://github.com/madbomber/aia) prompts as cron jobs. Add a `schedule:` key to any prompt's YAML frontmatter — `aias update` does the rest.
|
|
32
|
+
|
|
33
|
+
No separate configuration file. No daemon. The OS cron daemon runs each job as a fresh `aia` process.
|
|
34
|
+
|
|
35
|
+
## Installation
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
gem install aias
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Or add to your `Gemfile`:
|
|
42
|
+
|
|
43
|
+
```ruby
|
|
44
|
+
gem "aias"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**Requirements:** Ruby >= 3.2, the `aia` CLI installed and reachable in your login shell, `AIA_PROMPTS_DIR` set to your prompts directory.
|
|
48
|
+
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
$ aias help
|
|
53
|
+
Commands:
|
|
54
|
+
aias add PATH # Add (or replace) a single scheduled prompt in the crontab
|
|
55
|
+
aias check # Diff view: scheduled prompts vs what is installed
|
|
56
|
+
aias clear # Remove all aias-managed crontab entries
|
|
57
|
+
aias dry-run # Show what `update` would write without touching the crontab
|
|
58
|
+
aias help [COMMAND] # Describe available commands or one specific command
|
|
59
|
+
aias install [PATTERN...] # Capture PATH, API keys, and env vars into ~/.config/aia/schedule/env.sh
|
|
60
|
+
aias last [N] # Show last-run time for installed jobs (default 5)
|
|
61
|
+
aias list # List all installed aias cron jobs
|
|
62
|
+
aias next [N] # Show next scheduled run time for installed jobs (default 5)
|
|
63
|
+
aias remove PROMPT_ID # Remove a single scheduled prompt from the crontab
|
|
64
|
+
aias show PROMPT_ID # Show the installed crontab entry for a single prompt
|
|
65
|
+
aias uninstall # Remove managed env block from ~/.config/aia/schedule/env.sh
|
|
66
|
+
aias update # Scan prompts, regenerate all crontab entries, and install
|
|
67
|
+
aias version # Print the aias version
|
|
68
|
+
|
|
69
|
+
Options:
|
|
70
|
+
-p, [--prompts-dir=PROMPTS_DIR] # Prompts directory (overrides AIA_PROMPTS__DIR / AIA_PROMPTS_DIR env vars)
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Quick Start
|
|
74
|
+
|
|
75
|
+
**1. Capture your environment (once):**
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
aias install
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**2. Add a schedule to any prompt's frontmatter:**
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
---
|
|
85
|
+
schedule: "0 8 * * *"
|
|
86
|
+
description: Morning briefing
|
|
87
|
+
---
|
|
88
|
+
Summarize what happened overnight in the Ruby and AI ecosystems.
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**3. Validate and install:**
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
aias update
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**4. Verify:**
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
aias list
|
|
101
|
+
aias check
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Environment Setup
|
|
105
|
+
|
|
106
|
+
Cron runs with a minimal environment — no Ruby version manager, no API keys, no user-defined variables. `aias install` solves this by capturing your current shell environment into `~/.config/aia/schedule/env.sh`, which is sourced before every scheduled job.
|
|
107
|
+
|
|
108
|
+
### What gets captured automatically
|
|
109
|
+
|
|
110
|
+
| Variable group | Examples | Why |
|
|
111
|
+
|---|---|---|
|
|
112
|
+
| `PATH` | rbenv shims, Homebrew, gem bin dirs | `aia` and MCP server binaries must be findable |
|
|
113
|
+
| `*_API_KEY` | `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, etc. | LLM provider authentication |
|
|
114
|
+
| `AIA_*` | `AIA_PROMPTS__DIR`, `AIA_MODEL`, etc. | AIA runtime configuration |
|
|
115
|
+
| `LANG`, `LC_ALL` | `en_US.UTF-8` | Ruby UTF-8 string handling |
|
|
116
|
+
|
|
117
|
+
### MCP server credentials
|
|
118
|
+
|
|
119
|
+
If your scheduled prompts use MCP servers, those servers may need their own credentials — auth tokens, configuration paths, or other variables that are not covered by the defaults. Pass glob patterns to `aias install` to capture them:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
# GitHub MCP server (needs a personal access token)
|
|
123
|
+
aias install 'GITHUB_*'
|
|
124
|
+
|
|
125
|
+
# Homebrew MCP server
|
|
126
|
+
aias install 'HOMEBREW_*'
|
|
127
|
+
|
|
128
|
+
# Multiple patterns at once
|
|
129
|
+
aias install 'GITHUB_*' 'HOMEBREW_*'
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Check the documentation for each MCP server you use to identify the variables it reads, then add the corresponding pattern. Re-run `aias install` any time you add a new API key, install a new MCP server binary, or change your Ruby version.
|
|
133
|
+
|
|
134
|
+
## CLI Commands
|
|
135
|
+
|
|
136
|
+
| Command | Description |
|
|
137
|
+
|---|---|
|
|
138
|
+
| `aias install [PATTERN...]` | Capture PATH, API keys, and env vars into `env.sh`. Run once before scheduling. |
|
|
139
|
+
| `aias update` | Scan prompts, regenerate all crontab entries, install. Primary command. |
|
|
140
|
+
| `aias add PATH` | Add or replace a single prompt's cron job without touching others. |
|
|
141
|
+
| `aias remove PROMPT_ID` | Remove a single prompt's cron job. Aliases: `rm`, `delete`. |
|
|
142
|
+
| `aias check` | Diff view: prompts with `schedule:` vs what is installed. |
|
|
143
|
+
| `aias list` | Report all installed jobs: prompt ID, schedule, log file. |
|
|
144
|
+
| `aias dry-run` | Show what `update` would write without touching the crontab. |
|
|
145
|
+
| `aias show PROMPT_ID` | Show the installed crontab entry for a single prompt. |
|
|
146
|
+
| `aias next [N]` | Show next scheduled run time for installed jobs (default 5). |
|
|
147
|
+
| `aias last [N]` | Show last-run time for installed jobs (default 5). |
|
|
148
|
+
| `aias clear` | Remove all aias-managed crontab entries. Non-aias entries untouched. |
|
|
149
|
+
| `aias uninstall` | Remove the managed env block from `env.sh`. |
|
|
150
|
+
| `aias version` | Print the installed aias version. |
|
|
151
|
+
|
|
152
|
+
### `aias add PATH`
|
|
153
|
+
|
|
154
|
+
Installs or replaces the cron job for a single prompt file. All other installed jobs are left untouched. Errors immediately if the file has no `schedule:` in its frontmatter or fails validation.
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
aias add ~/.prompts/standup.md
|
|
158
|
+
# aias: added standup (every weekday at 9:00am (0 9 * * 1-5))
|
|
159
|
+
|
|
160
|
+
aias add ~/.prompts/drafts/idea.md
|
|
161
|
+
# aias [error] 'drafts/idea' has no schedule: in its frontmatter
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
Use `add` when you want to schedule a single new prompt without re-scanning the entire prompts directory. Use `update` to synchronise everything at once.
|
|
165
|
+
|
|
166
|
+
### Global Option
|
|
167
|
+
|
|
168
|
+
`--prompts-dir PATH` (alias `-p`) overrides the `AIA_PROMPTS__DIR` / `AIA_PROMPTS_DIR` environment variables for any command that reads prompt files:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
aias --prompts-dir ~/work/prompts update
|
|
172
|
+
aias -p ~/work/prompts dry-run
|
|
173
|
+
aias -p ~/work/prompts check
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Schedule Format
|
|
177
|
+
|
|
178
|
+
The `schedule:` value accepts a standard cron expression, a `@`-shorthand keyword, or a natural language string. Natural language parsing is provided by the [fugit](https://github.com/floraison/fugit) gem.
|
|
179
|
+
|
|
180
|
+
```yaml
|
|
181
|
+
schedule: "0 8 * * *" # cron expression
|
|
182
|
+
schedule: "@daily" # @ shorthand
|
|
183
|
+
schedule: "every day at 8am" # natural language
|
|
184
|
+
schedule: "every weekday at 9am" # natural language
|
|
185
|
+
schedule: "every monday at 9am" # natural language
|
|
186
|
+
schedule: "every monday through friday at 9am" # natural language
|
|
187
|
+
schedule: "every 6 hours" # natural language
|
|
188
|
+
schedule: "every 30 minutes" # natural language
|
|
189
|
+
schedule: "every 1st of the month at midnight" # natural language
|
|
190
|
+
schedule: "every day at 9am in America/New_York" # with timezone
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
Natural language strings are resolved to cron expressions at install time. Use `aias dry-run` to preview the resolved expression before installing. See [Scheduling Prompts](docs/guides/scheduling-prompts.md) for the full reference including all supported patterns, limitations, and a quick-reference table.
|
|
194
|
+
|
|
195
|
+
Once a prompt has been scheduled and resides in the crontab you **cannot** remove it just by deleting or commenting out the `schedule:` line. Run `aias update` (full sync) or `aias remove PROMPT_ID` to remove it.
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
## Validation
|
|
199
|
+
|
|
200
|
+
Before installing, `aias` validates each scheduled prompt:
|
|
201
|
+
|
|
202
|
+
- **Schedule syntax** — cron expression or natural language must be parseable
|
|
203
|
+
- **Parameter completeness** — all `parameters:` keys must have default values (interactive input is impossible in cron)
|
|
204
|
+
- **AIA binary** — `aia` must be locatable in PATH or a known version-manager shim directory (`~/.rbenv/shims`, `~/.rvm/bin`, `~/.asdf/shims`, `/opt/homebrew/bin`)
|
|
205
|
+
|
|
206
|
+
Invalid prompts are warned and excluded. The remaining valid prompts are installed.
|
|
207
|
+
|
|
208
|
+
## Logging
|
|
209
|
+
|
|
210
|
+
Each job logs to `~/.config/aia/schedule/logs/<prompt_id>.log`. stdout and stderr are combined and overwrite the log on each run.
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
~/.config/aia/schedule/logs/
|
|
214
|
+
daily_digest.log
|
|
215
|
+
reports/
|
|
216
|
+
weekly.log
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## How It Works
|
|
220
|
+
|
|
221
|
+
```
|
|
222
|
+
Prompt file with schedule: in YAML frontmatter
|
|
223
|
+
│
|
|
224
|
+
▼
|
|
225
|
+
aias update scans prompts directory for schedule: keys
|
|
226
|
+
│
|
|
227
|
+
▼
|
|
228
|
+
Each prompt is validated: schedule syntax, parameter defaults, aia binary
|
|
229
|
+
│
|
|
230
|
+
▼
|
|
231
|
+
A cron entry is written for each valid prompt
|
|
232
|
+
│
|
|
233
|
+
▼
|
|
234
|
+
OS cron daemon runs each job on schedule:
|
|
235
|
+
source env.sh && aia [--prompts-dir DIR] prompt_id > log 2>&1
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
## Development
|
|
239
|
+
|
|
240
|
+
```bash
|
|
241
|
+
bin/setup # install dependencies
|
|
242
|
+
bundle exec rake test # run all tests
|
|
243
|
+
bundle exec ruby -Ilib:test test/test_aias.rb # run a single test file
|
|
244
|
+
bin/console # interactive REPL
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## License
|
|
248
|
+
|
|
249
|
+
[MIT](LICENSE.txt)
|