Skip to content

Groom AGENTS.md: move project notes to README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sethmills21 merged 1 commit into from
Nov 1, 2026
Merged

Groom AGENTS.md: move project notes to README #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 0 additions & 32 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Guidance for coding agents working in this repository.

## Mission

Make Sonic feel like a real terminal product, not a code sketch. Favor changes that improve setup, safety, playback reliability, and the quality of the keyboard-driven UX.

## Current Scope

- YouTube-first CLI music player
Expand Down Expand Up @@ -60,34 +56,6 @@ lib/themes.js theme registry and palette helpers
- if you add another service, explain the API/auth/legal model in `README.md`
- if you touch theme work, keep the identity strong across the full TUI, not just the header

## Inspiration

Reference set for CLI/TUI quality:

- [`googleworkspace/cli`](https://github.com/googleworkspace/cli): installation, prerequisites, agent-ready framing, structured output.
- [`cli/cli`](https://github.com/cli/cli): command ergonomics, help UX, and polished distribution posture.
- [`alexknowshtml/api2cli`](https://github.com/alexknowshtml/api2cli): dual human/agent command design and self-documenting CLI patterns.
- [`asc`](https://asccli.sh/): focused workflow automation with a strong install/onboarding surface.
- [`Polymarket/polymarket-cli`](https://github.com/Polymarket/polymarket-cli): clear warnings, Homebrew install, scriptable terminal product design.
- [`google-gemini/gemini-cli`](https://github.com/google-gemini/gemini-cli) and [`superagent-ai/grok-cli`](https://github.com/superagent-ai/grok-cli): examples of modern agent CLI presentation.
- [`rothgar/awesome-tuis`](https://github.com/rothgar/awesome-tuis): broad TUI idea bank.

What to steal for Sonic:

1. excellent `--help`
2. clean install paths
3. obvious warnings around risky behavior
4. strong README and release posture
5. future-friendly script/agent integration without sacrificing the live TUI

## Preferred Roadmap

1. queue, favorites, recents, config
2. doctor/setup diagnostics
3. session integration
4. cleaner service adapter boundaries
5. broader platform support and release automation

## Validation

For meaningful changes:
Expand Down
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,40 @@ Connect walks you through three checked steps: install [spogo](https://github.co

**Node.js** 22+  ·  **yt-dlp**  ·  **mpv**  ·  macOS or Linux  ·  optional: **spogo** for Spotify

## Project notes

### Mission

Make Sonic feel like a real terminal product, not a code sketch. Favor changes that improve setup, safety, playback reliability, and the quality of the keyboard-driven UX.

### Inspiration

Reference set for CLI/TUI quality:

- [`googleworkspace/cli`](https://github.com/googleworkspace/cli): installation, prerequisites, agent-ready framing, structured output.
- [`cli/cli`](https://github.com/cli/cli): command ergonomics, help UX, and polished distribution posture.
- [`alexknowshtml/api2cli`](https://github.com/alexknowshtml/api2cli): dual human/agent command design and self-documenting CLI patterns.
- [`asc`](https://asccli.sh/): focused workflow automation with a strong install/onboarding surface.
- [`Polymarket/polymarket-cli`](https://github.com/Polymarket/polymarket-cli): clear warnings, Homebrew install, scriptable terminal product design.
- [`google-gemini/gemini-cli`](https://github.com/google-gemini/gemini-cli) and [`superagent-ai/grok-cli`](https://github.com/superagent-ai/grok-cli): examples of modern agent CLI presentation.
- [`rothgar/awesome-tuis`](https://github.com/rothgar/awesome-tuis): broad TUI idea bank.

What to steal for Sonic:

1. excellent `--help`
2. clean install paths
3. obvious warnings around risky behavior
4. strong README and release posture
5. future-friendly script/agent integration without sacrificing the live TUI

### Preferred Roadmap

1. queue, favorites, recents, config
2. doctor/setup diagnostics
3. session integration
4. cleaner service adapter boundaries
5. broader platform support and release automation

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) and [SECURITY.md](./SECURITY.md).
Expand Down
Loading