Skip to content

[AISOS-2124] Add quick start instructions to forge readme.md#124

Closed
forgeSmith-bot wants to merge 1 commit into
forge-sdlc:mainfrom
forgeSmith-bot:forge/aisos-2124
Closed

[AISOS-2124] Add quick start instructions to forge readme.md#124
forgeSmith-bot wants to merge 1 commit into
forge-sdlc:mainfrom
forgeSmith-bot:forge/aisos-2124

Conversation

@forgeSmith-bot

Copy link
Copy Markdown
Collaborator

This Pull Request implements task takeover for ticket [AISOS-2124].

Ticket Description

Add quick start instructions to forge readme.md. That should include starting the worker and the gatewy + all additional required services like redis and possible extra services like prometheus, langfuse and grafana

Co-authored-by: Forge forge@noreply.anthropic.com

Detailed description:
- Expanded the 'Quick Start' section in README.md with comprehensive instructions covering prerequisites, cloning, setting up the python environment with uv sync, configuring credentials, building task execution container images, running Redis Stack on port 6380, starting the FastAPI gateway, and starting the Forge worker process.
- Included setup references for optional observability services (local Prometheus & Grafana stack on ports 9092 & 3010 respectively via devtools docker-compose file) and Langfuse LLM tracing.
- Added a new unit test suite 'tests/unit/devtools/test_readme_docs.py' to verify the exact ports, paths, and startup commands mentioned in the README.md documentation are present and match.

Closes: AISOS-2124
@eshulman2 eshulman2 closed this Jul 6, 2026
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.

2 participants