Files
tool-evaluator/docs/releases/v0.9.0/handbook/getting-started.en.md
T
opencode 6eb3dfd8f9 docs: cut to v0.9.0 with unified .de/.en naming
- Remove all prior release notes and version snapshots (v0.6.0-v0.8.6)
- Rename handbook to *.de.md; keep *.en.md
- New release notes v0.9.0.de.md/.en.md with v0.9.0 snapshot
- generate-docs.mjs: .de/.en convention incl. search index and en-fallback
- docs.tsx: release fallback now uses version.de.md
- Wording: neutral tagline, anonymous user, no gender forms
- Add docs/examples/import-tools.yaml and link from administration docs
2026-08-05 00:13:41 +02:00

1.8 KiB
Raw Blame History

Getting Started

This page guides you through the most important workflows in toolr — from your first visit to creating and rating a tool.

1. Sign in

Most actions (create a tool, rate, watchlist, compare) require an account. Click Sign in in the bottom left corner. Depending on the instance configuration you have two options:

  • Local accounts: username + password. Access is created by an admin (see Administration).
  • OIDC (SSO): sign in with the configured identity provider (e.g. Keycloak).

Which mode is active is shown by the GET /auth/mode endpoint. Details can be found in the Sign in & account section.

2. Find tools

Open the Browse tools section:

  • Search — full-text search across name & description (shortcut /).
  • Filter — by category, tags, features and minimum rating (minRating).
  • Sort — by newest, top-rated, most rated, name (ascending/descending) or last update.

All options in detail: Find & browse tools.

3. Create a tool

Go to Add tool and fill in the form. Details for each field can be found in the Create a tool section and in the field reference.

4. Rate

On the detail page of a tool you can submit usefulness and usability (15 each) and optionally leave a comment. Your rating is immediately reflected in the statistics. See Rating.

5. Further reading