dcramer / dcramer/peated

Expand Peated CLI into an API-backed tool for agent-assisted data fixes and backfills

Open
#312 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement javascript
Dominant language
TypeScript
Stars
103
Forks
18
Avg merge
1h 19m
Merged PRs (30d)
555

Description

Summary

We should expand the existing CLI into a Peated CLI that can be used by humans and agents to backfill and repair data without needing direct server or DB access.

Goals

  • Map CLI commands onto existing API/oRPC endpoints wherever possible.
  • Make batch and agent workflows easier for backfills, one-off fixes, and data cleanup.
  • Add an auth flow for CLI usage via an API token instead of direct app internals.
  • Reuse the existing access-token pattern where possible, likely similar to how iOS authenticates today.

Scope

  • Audit the current endpoints that already support data maintenance workflows.
  • Add command groups around the highest-value operations instead of bespoke server-only logic.
  • Support generating, storing, and using a bearer token from the CLI.
  • Prefer thin wrappers over existing endpoints so CLI behavior stays aligned with the app.

Open Questions

  • Should this build on the current apps/cli package or ship as a separate user-facing CLI package?
  • Do we want personal-access-token style auth, or a login flow that exchanges for an access token?
  • Which commands should be first-class in v1: bottles, entities, prices, reviews, tastings, or something else?

Success Criteria

  • A contributor or agent can authenticate from the CLI.
  • Common backfill and repair workflows can run through existing endpoints.
  • CLI output is predictable and scriptable enough for automation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the existing apps/cli package and audit the API/oRPC endpoints that support data maintenance workflows. Compare the possible CLI authentication approaches with the existing iOS access-token pattern, then resolve which command group and package direction should be first. Done means the scope, auth flow, initial commands, and scriptable output behavior are agreed and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend-api-design, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.