Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ The default config file is `.org-cli.yaml` in the current working directory.

Top-level sections:

- `defaults` - default values for built-in CLI options (for example `--filter-priority`, `--order-by-priority`, `--buckets`)
- shared top-level option defaults such as `todo_states`, `done_states`, `mapping`, `exclude`, filters, ordering flags, and color behavior
- `filter` - custom `--filter-<name>` query snippets
- `order-by` - custom `--order-by-<name>` query snippets
- `with` - custom `--with-<name>` query snippets
- `tasks` - task-command defaults and capture templates
- `stats` - stats subcommand defaults
- `agenda` - agenda defaults and named views
- `board` - board defaults and named views

## Development Setup
Several helpful Poetry tasks are defined in `pyproject.toml` that automate running mundane tasks. These tasks should be used whenever possible instead of running individual commands.
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@ This installs the `org` command.

Top-level config sections:

- `defaults` for built-in option defaults
- shared top-level option defaults such as `todo_states`, `done_states`, `mapping`, `exclude`, filters, ordering flags, and color behavior
- `filter` for custom `--filter-<name>` query snippets
- `order-by` for custom `--order-by-<name>` query snippets
- `with` for custom `--with-<name>` query snippets
- `capture` for named task capture templates
- `tasks` for task-command defaults and named capture templates
- `stats` for stats subcommand defaults
- `agenda` for named agenda views
- `board` for named board views
- `board` for board defaults and named board views

See [docs/index.md](docs/index.md) for the full config layout.

Expand Down
Loading
Loading