Quickstart

This guide gets you from zero to your first dashboard update or notification in just a few steps.

1. Initialize Config

obsern init

This creates obsern.yaml.

2. Configure One Delivery Path

Edit obsern.yaml and set at least one:

• api.host_token and api.base_url for dashboard/API delivery
• notify.slack.webhook_url for Slack delivery
• notify.discord.webhook_url for Discord delivery

Minimal notification example:

run:
  tags: ["default"]
  tail_lines: 80

notify:
  time_zone: "Asia/Tokyo"
  discord:
    webhook_url: ${OBSERN_DISCORD_WEBHOOK_URL}

3. Run a Command Through Obsern

obsern run sh -c "echo start && sleep 2 && echo done"

4. Confirm Result

• If a notification provider is configured, confirm that a message is posted.
• If the API is configured, confirm that the run appears in the dashboard.

5. Try a Failure Case

obsern run sh -c "echo failing && exit 1"

If a notification provider is configured, you should receive a failure notification. If the API is configured, the job should appear with a failed status in the dashboard.

Next Step

Go to Configuration for full field details.