Skip to content

Commit 29dd6c2

Browse files
arimxyerclaude
andcommitted
docs: fix placeholder URLs and update post-install messages
- Replace placeholder GitHub URLs (github.com/username, github.com/user) with actual repository (github.com/ari1110/pass-cli) - Update Homebrew/Scoop/GoReleaser post-install messages to mention TUI, doctor, guided init, and keychain features - Fix deprecated --vault flag examples in MIGRATION.md to use config file approach - Add vault remove command to README core commands list - Update keychain status documentation links to point to actual GitHub docs Files updated: - cmd/root.go: Fixed placeholder URLs in help text and migration guidance - cmd/keychain_status.go: Updated docs URL to GitHub - docs/DOCTOR_COMMAND.md: Fixed placeholder URL in example output - docs/MIGRATION.md: Replaced --vault flag with config file approach in Option C - homebrew/pass-cli.rb: Enhanced caveats with modern features - scoop/pass-cli.json: Enhanced post_install and notes sections - .goreleaser.yml: Updated brew/scoop messages, removed --vault flag - README.md: Added vault remove to core commands - specs/002-fix-untested-features/quickstart.md: Fixed import path placeholders 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f0fd7bb commit 29dd6c2

File tree

9 files changed

+82
-36
lines changed

9 files changed

+82
-36
lines changed

.goreleaser.yml

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,22 @@ brews:
288288
289289
# Caveats shown after installation
290290
caveats: |
291-
To get started with Pass-CLI:
292-
pass-cli --vault ~/.pass-cli.enc init
291+
Pass-CLI: Secure password manager with TUI and CLI interfaces
292+
293+
First-time users: Run `pass-cli` (no arguments) for guided setup.
294+
295+
Quick start:
296+
pass-cli - Launch interactive TUI
297+
pass-cli init - Initialize vault manually
298+
pass-cli doctor - Run health checks
299+
300+
Features:
301+
• Interactive TUI for visual management
302+
• Keychain integration: pass-cli keychain enable
303+
• Usage tracking and audit logging
304+
305+
Vault location: ~/.pass-cli/vault.enc
306+
Complete guide: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md
293307
294308
# Scoop bucket (automated manifest creation and updates)
295309
scoops:
@@ -311,5 +325,6 @@ scoops:
311325

312326
# Post-install message (array of PowerShell commands)
313327
post_install:
314-
- "Write-Host 'To get started with Pass-CLI:' -ForegroundColor Green"
315-
- "Write-Host ' pass-cli --vault $env:USERPROFILE\\.pass-cli.enc init' -ForegroundColor Cyan"
328+
- "Write-Host 'Pass-CLI installed! First-time: Run `pass-cli` for guided setup.' -ForegroundColor Green"
329+
- "Write-Host 'TUI: pass-cli | Health check: pass-cli doctor | Enable keychain: pass-cli keychain enable' -ForegroundColor Cyan"
330+
- "Write-Host 'Guide: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md' -ForegroundColor Yellow"

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,9 @@ pass-cli delete github
122122
# Generate password
123123
pass-cli generate --length 32
124124

125+
# Remove vault
126+
pass-cli vault remove
127+
125128
# Health check
126129
pass-cli doctor
127130
```

cmd/keychain_status.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,12 @@ func runKeychainStatus(cmd *cobra.Command, args []string) error {
116116
} else if meta != nil && !meta.KeychainEnabled {
117117
fmt.Printf("✓ Vault Configuration: Keychain not enabled\n\n")
118118
fmt.Println("System keychain is not accessible. You will be prompted for password on each command.")
119-
fmt.Println("See documentation for keychain setup: https://docs.pass-cli.com/keychain")
119+
fmt.Println("See documentation for keychain setup: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md#keychain-integration")
120120
} else {
121121
// No metadata - legacy vault
122122
fmt.Println()
123123
fmt.Println("System keychain is not accessible. You will be prompted for password on each command.")
124-
fmt.Println("See documentation for keychain setup: https://docs.pass-cli.com/keychain")
124+
fmt.Println("See documentation for keychain setup: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md#keychain-integration")
125125
}
126126
}
127127

cmd/root.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Examples:
5050
# List all credentials
5151
pass-cli list
5252
53-
For more information, visit: https://github.com/username/pass-cli`,
53+
For more information, visit: https://github.com/ari1110/pass-cli`,
5454
PersistentPreRunE: checkFirstRun,
5555
Run: runRootCommand,
5656
}
@@ -79,7 +79,7 @@ Instead, configure your vault location in the config file:
7979
3. Run your command without the --vault flag
8080
8181
For more details, see the migration guide:
82-
https://github.com/username/pass-cli/docs/MIGRATION.md
82+
https://github.com/ari1110/pass-cli/blob/main/docs/MIGRATION.md
8383
8484
Original error: %w`, os.Getenv("HOME"), err)
8585
}

docs/DOCTOR_COMMAND.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ esac
139139
**Symptom**:
140140
```
141141
⚠ Version: Update available: v1.2.3 → v1.2.4
142-
Recommendation: Update to latest version: https://github.com/user/pass-cli/releases/tag/v1.2.4
142+
Recommendation: Update to latest version: https://github.com/ari1110/pass-cli/releases/tag/v1.2.4
143143
```
144144

145145
**Solution**: Update pass-cli to the latest version using your package manager or download from GitHub.

docs/MIGRATION.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,23 +233,35 @@ pass-cli migrate --iterations 600000 --enable-audit
233233

234234
1. **Create new vault in custom location**:
235235
```bash
236-
pass-cli --vault ~/.pass-cli/vault-new.enc init --enable-audit
236+
# Create config for new vault
237+
mkdir -p ~/.pass-cli
238+
echo "vault_path: ~/.pass-cli/vault-new.enc" > ~/.pass-cli/config-new.yml
239+
240+
# Initialize new vault
241+
pass-cli --config ~/.pass-cli/config-new.yml init --enable-audit
237242
```
238243

239244
2. **Add new credentials to new vault**:
240245
```bash
241-
pass-cli --vault ~/.pass-cli/vault-new.enc add newservice
246+
pass-cli --config ~/.pass-cli/config-new.yml add newservice
242247
```
243248

244249
3. **Keep old vault for existing credentials**:
245250
```bash
246-
pass-cli --vault ~/.pass-cli/vault-old.enc get oldservice
251+
# Use default config (points to ~/.pass-cli/vault.enc)
252+
pass-cli get oldservice
247253
```
248254

249255
4. **Switch to new vault when ready**:
250256
```bash
251-
mv ~/.pass-cli/vault-old.enc ~/.pass-cli/vault-old-backup.enc
257+
# Backup old vault
258+
mv ~/.pass-cli/vault.enc ~/.pass-cli/vault-old-backup.enc
259+
260+
# Promote new vault to default
252261
mv ~/.pass-cli/vault-new.enc ~/.pass-cli/vault.enc
262+
263+
# Update default config (or remove custom config file)
264+
rm ~/.pass-cli/config-new.yml
253265
```
254266

255267
## Backward Compatibility

homebrew/pass-cli.rb

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,22 @@ def install
3939

4040
def caveats
4141
<<~EOS
42-
Pass-CLI is a secure password manager that stores credentials locally.
42+
Pass-CLI: Secure password manager with TUI and CLI interfaces
4343
44-
To get started:
45-
1. Initialize your vault: pass-cli init
46-
2. Add a credential: pass-cli add myservice
47-
3. Retrieve it: pass-cli get myservice
44+
First-time users: Run `pass-cli` (no arguments) for guided setup.
4845
49-
Your vault is stored at: ~/.pass-cli/
46+
Quick start:
47+
pass-cli - Launch interactive TUI
48+
pass-cli init - Initialize vault manually
49+
pass-cli doctor - Run health checks
5050
51-
For more information, run: pass-cli --help
51+
Features:
52+
• Interactive TUI for visual management
53+
• Keychain integration: pass-cli keychain enable
54+
• Usage tracking and audit logging
55+
56+
Vault location: ~/.pass-cli/vault.enc
57+
Complete guide: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md
5258
EOS
5359
end
5460

scoop/pass-cli.json

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,34 @@
3434
"post_install": [
3535
"Write-Host 'Pass-CLI has been installed successfully!' -ForegroundColor Green",
3636
"Write-Host ''",
37-
"Write-Host 'To get started:' -ForegroundColor Yellow",
38-
"Write-Host ' 1. Initialize your vault: pass-cli init'",
39-
"Write-Host ' 2. Add a credential: pass-cli add myservice'",
40-
"Write-Host ' 3. Retrieve it: pass-cli get myservice'",
37+
"Write-Host 'First-time users: Run `pass-cli` (no arguments) for guided setup.' -ForegroundColor Yellow",
4138
"Write-Host ''",
42-
"Write-Host 'Your vault will be stored at: ~\\.pass-cli\\' -ForegroundColor Cyan",
43-
"Write-Host 'For more information, run: pass-cli --help'"
39+
"Write-Host 'Quick start:' -ForegroundColor Yellow",
40+
"Write-Host ' pass-cli - Launch interactive TUI'",
41+
"Write-Host ' pass-cli init - Initialize vault manually'",
42+
"Write-Host ' pass-cli doctor - Run health checks'",
43+
"Write-Host ''",
44+
"Write-Host 'Your vault will be stored at: ~\\.pass-cli\\vault.enc' -ForegroundColor Cyan",
45+
"Write-Host 'Complete guide: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md'"
4446
],
4547
"notes": [
46-
"Pass-CLI stores credentials securely using Windows Credential Manager.",
47-
"Your vault is encrypted with AES-256-GCM encryption.",
48+
"Pass-CLI: Secure password manager with TUI and CLI interfaces",
49+
"",
50+
"Key Features:",
51+
" • Interactive TUI for visual credential management",
52+
" • Windows Credential Manager integration (enable: pass-cli keychain enable)",
53+
" • Health diagnostics (run: pass-cli doctor)",
54+
" • Usage tracking across projects",
55+
" • AES-256-GCM encryption with audit logging",
4856
"",
49-
"Quick start:",
50-
" pass-cli init - Initialize a new vault",
51-
" pass-cli add <name> - Add a new credential",
52-
" pass-cli get <name> - Retrieve a credential",
53-
" pass-cli list - List all credentials",
57+
"Quick commands:",
58+
" pass-cli - Launch TUI (first-time: guided setup)",
59+
" pass-cli add <name> - Add credential",
60+
" pass-cli get <name> - Retrieve credential",
61+
" pass-cli list - List all credentials",
62+
" pass-cli keychain enable - Enable auto-unlock",
63+
" pass-cli doctor - Verify vault health",
5464
"",
55-
"Run 'pass-cli --help' for full documentation."
65+
"Documentation: https://github.com/ari1110/pass-cli/blob/main/docs/GETTING_STARTED.md"
5666
]
5767
}

specs/002-fix-untested-features/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ import (
160160
"testing"
161161
"time"
162162

163-
"github.com/yourusername/pass-cli/internal/vault"
163+
"github.com/ari1110/pass-cli/internal/vault"
164164
"github.com/stretchr/testify/assert"
165165
"github.com/stretchr/testify/require"
166166
)
@@ -229,7 +229,7 @@ package cmd
229229
import (
230230
"fmt"
231231
"github.com/spf13/cobra"
232-
"github.com/yourusername/pass-cli/internal/vault"
232+
"github.com/ari1110/pass-cli/internal/vault"
233233
)
234234

235235
func init() {

0 commit comments

Comments
 (0)