@holdyourvoice/hyv 0.1.0 → 0.2.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.
@@ -1,56 +1,37 @@
1
- # Hold Your Voice (HYV)
1
+ # Hold Your Voice — Agent Command
2
2
 
3
- When the user asks to write, rewrite, or edit text "in their voice", "using their brand voice", mentions `hyv`, or references a voice profile name use the `hyv` CLI.
3
+ When the user mentions "voice", "brand voice", "hyv", "write in my voice", or "rewrite in my voice":
4
4
 
5
- ## Triggers
5
+ ## Inline rewrite (text in conversation)
6
6
 
7
- Recognize these patterns:
8
- - `hyv shashank` or `hyv <name>` — rewrite using the named voice profile
9
- - `write this in my voice` / `rewrite in my voice` — use the default profile
10
- - `check my voice` / `scan my voice` / `voice check` — run `hyv scan`
11
- - `voice status` / `hyv status` — show account status
12
-
13
- ## Workflow
14
-
15
- ### To rewrite text in a user's voice:
16
-
17
- 1. If there's a draft file, run:
7
+ 1. Capture the text the user wants rewritten (previous message, code block, paragraph, etc.)
8
+ 2. Run:
18
9
  ```bash
19
- hyv rewrite <profile> <file>
10
+ hyv rewrite <profile> --text "the captured text"
20
11
  ```
21
- If no file, pipe the text:
12
+ Or if no profile mentioned, use the default:
22
13
  ```bash
23
- echo "the draft text" | hyv rewrite <profile>
14
+ hyv rewrite --text "the captured text"
24
15
  ```
16
+ 3. Read the structured prompt from stdout
17
+ 4. Execute the rewrite following the prompt's instructions
18
+ 5. Present the rewritten text directly in the conversation
25
19
 
26
- 2. The CLI outputs a structured prompt to stdout. Read it.
27
-
28
- 3. Execute the rewrite following the prompt's instructions. The prompt contains:
29
- - The voice profile (keywords, tone, anchors, never-list)
30
- - Issues found in the draft
31
- - The draft text
32
- - Rewrite rules
33
-
34
- 4. Present the rewritten text to the user.
35
-
36
- ### To check writing for issues:
20
+ ## File rewrite
37
21
 
38
22
  ```bash
39
- hyv scan
23
+ hyv rewrite <profile> <file.md>
40
24
  ```
41
25
 
42
- This scans all `.md` files in the current directory. Shows issues with line numbers and severity.
43
-
44
- ### To list available profiles:
26
+ ## Scan for issues
45
27
 
46
28
  ```bash
47
- hyv profiles
29
+ hyv scan
48
30
  ```
49
31
 
50
32
  ## Rules
51
33
 
52
- - The CLI never calls an LLM. It generates prompts. You execute them.
53
- - Always preserve the original meaning when rewriting.
54
- - Match the voice profile's rhythm, vocabulary, and patterns.
55
- - If no profile is specified, use the default from `.hyv.yml` or ask the user.
56
- - If the CLI isn't installed, tell the user to run `npx @holdyourvoice/hyv init`.
34
+ - The CLI never calls an LLM. It generates prompts. **You** execute the rewrite.
35
+ - Preserve original meaning. Match the voice profile's rhythm, vocabulary, patterns.
36
+ - If no profile specified, check `.hyv.yml` or ask the user.
37
+ - If CLI not installed: `npx @holdyourvoice/hyv init`
package/agents/codex.md CHANGED
@@ -1,25 +1,35 @@
1
- # Hold Your Voice (HYV) — Codex Integration
1
+ # Hold Your Voice (HYV)
2
2
 
3
- When the user mentions "voice", "brand voice", "hyv", or asks to rewrite in their voice, use the `hyv` CLI.
3
+ When the user mentions "voice", "brand voice", "hyv", "write in my voice", or "rewrite in my voice":
4
4
 
5
- ## Quick Reference
5
+ ## Inline rewrite (text in conversation)
6
6
 
7
- | User says | Command |
8
- |-----------|---------|
9
- | `hyv <name>` | `hyv rewrite <name> <current-file>` |
10
- | `write this in my voice` | `hyv rewrite <default-profile> <file>` |
11
- | `check my voice` | `hyv scan` |
12
- | `voice profiles` | `hyv profiles` |
13
- | `voice status` | `hyv status` |
7
+ 1. Capture the text the user wants rewritten
8
+ 2. Run: `hyv rewrite <profile> --text "captured text"`
9
+ 3. Read the structured prompt from stdout
10
+ 4. Execute the rewrite and present it
14
11
 
15
- ## How rewrite works
12
+ ## File rewrite
16
13
 
17
- 1. Run `hyv rewrite <profile> <file>` — outputs a structured prompt to stdout
18
- 2. Read the prompt and execute the rewrite
19
- 3. Present the rewritten text
14
+ ```bash
15
+ hyv rewrite <profile> file.md
16
+ ```
17
+
18
+ ## Scan
19
+
20
+ ```bash
21
+ hyv scan
22
+ ```
20
23
 
21
- ## Install
24
+ ## Profiles
22
25
 
23
26
  ```bash
24
- npx @holdyourvoice/hyv init
27
+ hyv profiles
25
28
  ```
29
+
30
+ ## Rules
31
+
32
+ - CLI generates prompts. You execute the rewrite.
33
+ - Preserve meaning. Match the voice profile.
34
+ - If no profile: check `.hyv.yml` or ask user.
35
+ - If not installed: `npx @holdyourvoice/hyv init`