OpenHands/agent-canvas

Quick start doesn't clearly indicate what URL to visit and next steps after installation

Open

#881 opened on May 28, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (26 forks)github user discovery
good first issue

Repository metrics

Stars
 (43 stars)
PR merge metrics
 (PR metrics pending)

Description

Summary

After running installation commands, users need to navigate to a specific URL (http://localhost:8000) to use the application, but this isn't prominently displayed in the quick start flow. The success state and next steps aren't clearly communicated.

Priority

🔵 Medium - Improves user experience and reduces confusion after installation.

Current State

The README currently shows installation commands for three options, then at the very end (line 93) states:

Access the UI at http://localhost:8000. You can add additional backends directly from the UI.

This appears after all three installation options and is easy to miss.

Issues

  1. URL not shown in context of each installation method

    • Users complete installation but don't know what to do next
    • The URL is mentioned once at the bottom, not per-option
  2. No expected output or success indicators

    • Users don't know if installation succeeded
    • No sample output showing what a successful start looks like
    • No troubleshooting tips if the expected output doesn't appear
  3. No "Next Steps" guidance

    • After accessing the UI, users may not know what to do
    • No link to a "Getting Started" guide or first-use tutorial
    • No explanation of what to expect in the UI

Proposed Solution

1. Add "Next Steps" to each installation option

For Docker:

### Option 1: Docker

[...installation commands...]

Once the container is running, you should see output like:

Agent Canvas started successfully Listening on http://localhost:8000


✅ **Next**: Open http://localhost:8000 in your browser to access the UI.

For npm:

### Option 2: NPM

[...installation commands...]

The server will start automatically. You should see:

Agent Canvas Started agent-server at http://localhost:18000 Started automation backend at http://localhost:18001 Started frontend at http://localhost:3001 Ingress proxy listening on http://localhost:8000


✅ **Next**: Open http://localhost:8000 in your browser to access the UI.

2. Add a dedicated "Next Steps" section

After all installation options:

## Next Steps

1. **Access the UI**: Navigate to http://localhost:8000 in your web browser

2. **Configure LLM**: On first launch, you'll be prompted to:
   - Select your LLM provider (OpenAI, Anthropic, etc.)
   - Enter your API key
   - Choose a model

3. **Start your first conversation**: 
   - Create a new conversation from the sidebar
   - Try asking the agent to help with a coding task

4. **Add backends** (optional): You can connect to multiple agent servers from Settings > Agent Server

For more details, see [DEVELOPMENT.md](./DEVELOPMENT.md) or [SELF_HOSTING.md](./SELF_HOSTING.md).

Acceptance Criteria

  • Show expected output after successful installation for each method
  • Highlight the URL to visit (http://localhost:8000) prominently
  • Include a "Next Steps" section with first-use guidance
  • Link to relevant documentation for deeper configuration
  • Consider adding a troubleshooting section for common issues

Related Files

  • README.md (lines 44-93)

Additional Context

Current line 93:

Access the UI at http://localhost:8000. You can add additional backends directly from the UI.

This is mentioned only once and easy to overlook when scanning the README.


Source: This issue was identified during a user onboarding session where the post-installation steps were not immediately clear from the documentation.

Contributor guide