Skip to content

Update README: setup, multi-line input modes, structured output#2

Merged
shauryajain21 merged 1 commit into
mainfrom
staging
May 27, 2026
Merged

Update README: setup, multi-line input modes, structured output#2
shauryajain21 merged 1 commit into
mainfrom
staging

Conversation

@shauryajain21
Copy link
Copy Markdown
Contributor

Summary

Bring the README in line with the 0.6.0 CLI:

  • Document linkup setup (was missing from commands table)
  • Document --clipboard, --file, stdin, and interactive paste modes
  • Document structured output type with --schema-file / --schema examples
  • Add aliases column (s, f, c) to commands table
  • Note LINKUP_API_KEY env var precedence and Linux clipboard prerequisites

Fixes

  • --deep--depth deep (the old flag was broken)
  • "Get sources" description corrected — --output searchResults returns raw results, not AI sources
  • Lead install instructions with pipx since plain pip hits "externally-managed-environment" on modern macOS/Linux

Test plan

  • All commands and aliases referenced in the README resolve in the installed CLI
  • All flags documented match linkup search --help output

@shauryajain21 shauryajain21 merged commit e8666dd into main May 27, 2026
4 checks passed
@shauryajain21 shauryajain21 deleted the staging branch May 27, 2026 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant