Reference System
Link tasks and documentation with @mentions
How to link tasks and documentation using @ syntax.
Overview
Knowns uses @ references to create links between tasks and documentation. This allows AI assistants to automatically fetch related context.
Reference Formats
Task References
| Format |
Example |
Description |
| User input |
@task-42 |
Short format |
| System output |
@.knowns/tasks/task-42 - Title.md |
Full path format |
Document References
| Format |
Example |
Description |
| User input |
@doc/patterns/auth |
Without .md extension |
| User input |
@doc/patterns/auth.md |
With .md extension |
| System output |
@.knowns/docs/patterns/auth.md |
Full path format |
Template References
| Format |
Example |
Description |
| User input |
@template/component |
Template name |
| System output |
@.knowns/templates/component |
Full path format |
Imported Document References
| Format |
Example |
Description |
| User input |
@doc/imports/alias/path |
Imported doc path |
| System output |
@.knowns/docs/imports/alias/path.md |
Full path format |
Usage Examples
In Task Description
knowns task create "Add login endpoint" \
-d "Implement JWT login following @doc/patterns/auth. Related: @task-38"
In Document Content
# Authentication Guide
This guide covers our authentication patterns.
## Related Tasks
- @task-42 - Initial auth implementation
- @task-45 - Add refresh tokens