Skip to content

Update CLI commands and documentation for remote service registration#2789

Merged
Devesh36 merged 2 commits into
Tracer-Cloud:mainfrom
Devesh36:deploy
Jun 10, 2026
Merged

Update CLI commands and documentation for remote service registration#2789
Devesh36 merged 2 commits into
Tracer-Cloud:mainfrom
Devesh36:deploy

Conversation

@Devesh36

Copy link
Copy Markdown
Collaborator

Stale opensre deploy references after deploy command removal

Issue

The CLI landing page and documentation still advertised opensre deploy ec2, but the deploy command was removed from the CLI. There is no app/cli/commands/deploy.py anymore — only commands like remote, investigate, onboard, etc. are registered under app/cli/commands/.

Users who followed the landing page or docs would hit:

Error: No such command 'deploy'.

Affected locations

Location Stale content
app/cli/support/layout.py Landing page quick-start: opensre deploy ec2
docs/remote-runtime-investigation.mdx Prerequisites and setup steps referencing opensre deploy
docs/DEVELOPMENT.md opensre deploy railway --project ... --service ...
app/remote/runtime_alert.py Error suggestion: Deploy with 'opensre deploy'

Root cause

Docs and UI examples were not updated when the deploy CLI command was removed. Deployment is now done through the hosting provider (Railway, EC2, Dockerfile, etc.), and remotes are registered via opensre remote.


Fix

Replace all stale opensre deploy references with the current workflow:

  1. Deploy the OpenSRE service using your hosting provider (see Deployment).
  2. Register the remote agent with opensre remote --url <url> health or the interactive opensre remote wizard.
  3. Investigate deployed services with opensre investigate --service <name>.

Changes

File Change
app/cli/support/layout.py Replaced opensre deploy ec2 with opensre investigate --service <name> on the landing page
docs/remote-runtime-investigation.mdx Updated prerequisites and setup to use remote --url and link to Deployment docs
app/remote/runtime_alert.py Updated missing-remote error to suggest opensre remote --url <url> health
docs/DEVELOPMENT.md Replaced opensre deploy railway with Railway's normal deploy flow plus remote health registration

Historical changelog entries in docs/daily-updates/ were left unchanged (they document past releases).

Verification

uv run python -m pytest tests/cli/test_layout.py tests/remote/test_runtime_alert.py -q

@github-actions

Copy link
Copy Markdown
Contributor

Greptile code review

This repo uses Greptile for automated review. Before merge, aim for Confidence Score: 5/5 with zero unresolved review threads — see CONTRIBUTING.md.

Run a review — add a PR comment with:

@greptile review

Give it ~5-10 minutes (sometimes longer) for results, then fix feedback and re-trigger until you reach Confidence Score: 5/5.

Optional: automate with the greploop skill.

@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR removes all stale opensre deploy references across four files and replaces them with the current two-step workflow: deploy via your hosting provider, then register the remote agent with opensre remote --url <url> health.

  • app/cli/support/layout.py & app/remote/runtime_alert.py: Single-line string fixes — the landing-page quick-start and the missing-remote error suggestion now point to valid commands.
  • docs/DEVELOPMENT.md & docs/remote-runtime-investigation.mdx: Documentation updated to separate the provider-managed deploy step from the CLI registration step, and the old positional-URL syntax (opensre remote health <url>) is corrected to the --url flag form (opensre remote --url <url> health) that matches the actual Click group definition.

Confidence Score: 5/5

All four changes are string-only fixes correcting stale command references; no logic, data, or control flow is altered.

Every changed line is either a documentation string or a user-facing error suggestion. The new commands match the actual CLI definitions in the codebase, and the corrected --url-flag syntax in the mdx file aligns with the Click group option. No runtime behaviour is affected.

No files require special attention.

Important Files Changed

Filename Overview
app/cli/support/layout.py Replaced stale opensre deploy ec2 landing-page example with opensre investigate --service <name>; single-line string change, no logic affected.
app/remote/runtime_alert.py Updated missing-remote error suggestion from the removed opensre deploy to the current opensre remote --url <url> health registration workflow.
docs/DEVELOPMENT.md Replaced opensre deploy railway … command block with a prose deploy step (linking to deployment.mdx) followed by the remote-registration health command.
docs/remote-runtime-investigation.mdx Updated prerequisites to replace opensre deploy ec2 with the two-step host-provider deployment + opensre remote --url … health registration; also corrects the old positional-URL syntax to the --url flag accepted by the Click group.

Sequence Diagram

sequenceDiagram
    participant User
    participant HostingProvider as Hosting Provider (Railway / EC2 / etc.)
    participant CLI as opensre CLI
    participant Remote as Remote Agent

    User->>HostingProvider: Deploy OpenSRE service (Dockerfile / native workflow)
    HostingProvider-->>User: Service URL

    User->>CLI: opensre remote --url https://… health
    CLI->>Remote: GET /health
    Remote-->>CLI: Health report
    CLI-->>User: Saves remote as custom

    User->>CLI: opensre investigate --service custom
    CLI->>Remote: Gather live signals (deployment status, logs, health)
    Remote-->>CLI: Evidence payload
    CLI-->>User: RCA report
Loading

Reviews (2): Last reviewed commit: "Update documentation for remote agent re..." | Re-trigger Greptile

Comment thread docs/DEVELOPMENT.md Outdated
@Devesh36

Copy link
Copy Markdown
Collaborator Author

@greptile-apps review again

@Davidson3556

Copy link
Copy Markdown
Contributor

looks good to me

@Devesh36 Devesh36 merged commit 0db3bd3 into Tracer-Cloud:main Jun 10, 2026
14 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🏆 @Devesh36 did not come to play. PR opened. Review survived. Merged clean. Retire the jersey. 🎽


👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome.

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