Skip to content

AGENTS.md

Latest commit

 

History

History
74 lines (52 loc) · 2.32 KB

AGENTS.md

File metadata and controls

74 lines (52 loc) · 2.32 KB
Raw

Picofarm Agent Notes

Local utility script

There is a local-only helper script at:

scripts/dev.sh

It is intentionally excluded from Git via .git/info/exclude and must not be committed.

Useful commands:

scripts/dev.sh doctor
scripts/dev.sh status
scripts/dev.sh test
scripts/dev.sh build
scripts/dev.sh backend
scripts/dev.sh restart-backend
scripts/dev.sh stop-backend
scripts/dev.sh health
scripts/dev.sh logs
scripts/dev.sh lint
scripts/dev.sh frontend-build
scripts/dev.sh push

Defaults:

PICOFARM_BIN=/tmp/daedalus-current
PICOFARM_LOG=/tmp/opencode/daedalus-backend.log
PICOFARM_PORT=8084
PICOFARM_REMOTE=picofarm
PICOFARM_BRANCH=main

Use scripts/dev.sh backend after backend changes. It builds, restarts, and checks /health.

Use scripts/dev.sh test before finishing feature work when both backend and frontend may be affected.

Use scripts/dev.sh logs when backend health fails.

Documentation map

When changing behavior, operations, validation, API contracts, storage, security, or agent workflow, check the documentation under docs/:

  • docs/PROJECT_BASELINE.md — canonical stack/runtime defaults and validation gates.
  • docs/ARCHITECTURE.md — code layout, boundaries, and where to make common changes.
  • docs/API_CONTRACTS.md — HTTP/JSON conventions, route groups, and Go/TypeScript contract synchronization.
  • docs/REGRESSION_MATRIX.md — critical workflows to validate or automate.
  • docs/SECURITY_MODEL.md — CORS, secrets, uploads, backups, integrations, and sensitive endpoint guidance.
  • docs/SALES_CHANNELS.md — canonical guide for Etsy, Squarespace, Shopify, and future sales-channel providers/adapters.
  • docs/README.md — documentation maintenance policy.

When changing sales channels, product/listing sync, external order processing, product links, provider OAuth/API-key flows, or marketplace/storefront integrations, read docs/SALES_CHANNELS.md first and keep API, security, and regression docs aligned.

Keep docs factual and operational. Do not document planned behavior as current behavior.

Git policy

The user requested that code changes be committed from now on.

Do not commit local-only helper scripts. scripts/dev.sh is excluded locally.

Push normal commits to:

git push picofarm main

Never force-push unless the user explicitly asks.