@aiiware/aii 0.5.1 → 0.5.3

package/README.md

@@ -62,9 +62,14 @@ In agent mode, use these commands:
 /stats             Show session statistics (tokens, cost)
 /model <model>     Switch LLM model
 /provider <name>   Switch LLM provider
-/exit              Exit the session
+/context           View context window usage
 /init              Generate AGENTS.md for your project
+/init --with-hooks Generate AGENTS.md + hooks.json template
 /memory            View loaded project instructions
+/memory reload     Hot-reload instructions without restart
+/hooks             View configured hooks
+/hooks reload      Hot-reload hooks without restart
+/exit              Exit the session
 ```
 
 ### Keyboard Shortcuts
@@ -166,17 +171,61 @@ Prevents "token limit exceeded" errors in long conversations with intelligent au
 
 ## Project Instructions (v0.5.0)
 
-Teach the agent your project's conventions with `AGENTS.md`:
+Teach the agent your project's conventions. Create an `AGENTS.md` file in your project root, and the agent will automatically learn your coding standards, commands, and rules.
+
+### Quick Setup
 
 ```bash
-# Generate AGENTS.md for your project
+# Auto-generate AGENTS.md by analyzing your project
 /init
 
-# View loaded instructions
+# View what instructions are loaded
 /memory
 ```
 
-The `/init` command analyzes your project and generates an `AGENTS.md` file with detected commands, coding standards, and safety rules. The agent automatically loads these instructions at session start.
+The `/init` command detects your language, framework, build commands, and generates a customized `AGENTS.md`. Edit it to add your team's conventions.
+
+### Supported Files
+
+The agent discovers instruction files in this priority order:
+
+- `AII.md` or `AGENTS.md` in project root
+- `~/.aii/AGENTS.md` for global preferences
+
+### Example AGENTS.md
+
+```markdown
+# My Project
+
+## Commands
+- Build: `npm run build`
+- Test: `npm test`
+- Lint: `npm run lint`
+
+## Coding Standards
+- Use TypeScript strict mode
+- Prefer async/await over callbacks
+- Maximum line length: 100
+
+## Safety Rules
+Never modify without asking:
+- .env files
+- Database migrations
+```
+
+## Hooks (v0.5.0)
+
+Extend agent behavior with custom scripts. Create `.aii/hooks.json` to run scripts before/after tool execution:
+
+```bash
+# Generate a hooks template
+/init --with-hooks
+
+# View configured hooks
+/hooks
+```
+
+Hooks let you add validation, logging, or approval gates. See the [hooks documentation](https://aiiware.com/docs/hooks) for details.
 
 ## System Commands
 
@@ -205,4 +254,4 @@ aii --version      # Show version
 
 ## License
 
-Proprietary - Copyright 2025-present AiiWare.com. All Rights Reserved.
+Proprietary - Copyright 2025-present AiiWare.com. All Rights Reserved.