Skip to content

Initialization should add .ace-local gitignore rules and sample agent guidance for working with ace-* #279

@cs3b

Description

@cs3b

Problem

When initializing a new project with ACE, two practical repo-hygiene steps are easy to miss:

  1. ignore .ace-local/ and use it as the canonical place for temporary local artifacts
  2. add sample agent instructions that teach the coding agent how to work with ace-* correctly

We fixed both downstream in a real project, but they feel like initialization defaults rather than per-repo rediscovery.

Why this matters

ACE already demonstrates the right patterns in its own repository:

  • .ace-local is ignored in the ACE repo .gitignore
  • ACE's own AGENTS.md / CLAUDE.md teach the agent how to use ace-* commands directly and how to follow ACE workflow output

What is missing is a downstream-ready version of that guidance during project initialization.

Request

Please add these as part of project initialization / bootstrap:

1. .gitignore initialization snippet

Add a standard section for local ACE artifacts, for example:

# ACE local caches and artifacts
.ace-local/

And document that temporary local outputs should live under .ace-local/ subfolders instead of the repo root.

Examples:

  • .ace-local/review/screenshots/
  • .ace-local/bundle/
  • .ace-local/task/

2. Sample agent guide content

Add sample AGENTS.md / CLAUDE.md content for downstream repos that teaches the agent how to work with ACE.

Suggested topics:

  • use direct ace-* CLI commands
  • do not pipe / grep / post-process ace-* output
  • if ACE emits a file path, read that file next
  • use ACE workflows for onboarding / task context before editing
  • keep temporary artifacts under .ace-local/

Example guidance (sanitized, no customer-specific details):

## ACE Workflow
Use direct `ace-*` commands from the repo root.

- Good: `ace-bundle project`
- Bad: `ace-bundle project | head -40`

- Good: `ace-bundle wfi://onboard` then open the emitted file
- Bad: `ace-bundle wfi://onboard > /tmp/onboard.txt`

If an `ace-*` command returns a file path, read that file next instead of re-running the command with shell filters.

Store temporary artifacts under `.ace-local/` subfolders, for example:
- `.ace-local/review/screenshots/`
- `.ace-local/bundle/`

Where this seems to fit

Best fit looks like the project initialization flow / initialization skill, since this is repo bootstrap behavior rather than a one-off documentation tweak.

Expected outcome

New ACE-initialized repos would start with:

  • safer local artifact handling
  • less accidental commit noise
  • clearer agent behavior around ace-*
  • less repo-specific rework to teach agents how to use ACE properly

Metadata

Metadata

Assignees

No one assigned

    Labels

    ace:trackedTracked by internal ACE task

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions