Hinatadocs

Finding things

Hinata has two tools for finding things:

  • Command palette: when you are looking for one specific thing, like a ticket, a runbook or a person.
  • Issues list: when you want to see all work with certain traits, like every open bug or everything due this week.

Open the palette from anywhere

Press ⌘K on a Mac or Ctrl+K on Windows and Linux. Both shortcuts work on every platform. The hint on screen shows the key your keyboard has.

You can also click Search or jump to… in the top bar. It opens the same palette. On a phone it is a magnifier icon, and the palette fills the whole screen.

The palette opens over your current page. Anything half-typed stays. Press Esc or click the dimmed background to get back where you were.

It works while you are deep in something

The shortcut works across the whole app: reading an issue, dragging a card, in the middle of a comment. Only when another dialog is already open does the palette not open on top of it.

The command palette open over the dashboard, showing grouped results for the query "board" One query, grouped results: the chips show counts, and Enter opens the selected row.

What it searches

The palette finds everything you are allowed to open in Hinata. Results arrive grouped by scope, always in the same order:

ScopeWhat you find
CommandsPages and actions of the app, see It is also a command bar
IssuesThe title, the issue key (HIN-42), and labels, plus words from the description
CommentsComments on issues
ProjectsThe project name and its key, plus the project description
TeamsTeams you are a member of
PeopleDisplay name, username and job title
Boards & SprintsBoard names, sprint names and sprint goals
KnowledgeArticles with their title, labels and text, plus the spaces
AttachmentsFiles attached to issues
ShiftsEvents and single shifts from shift planning
Time trackingYour own time entries and timesheets
AbsencesYour own absence requests and the absence types
BillingBudgets and hourly rates

How matching works:

  • Short fields (titles, keys, names, labels) match partial text. len finds Lena, HIN-2 finds HIN-241.
  • Long fields (descriptions, article bodies) only match whole words. To find a sentence in a description, type whole words.

In All, each group shows at most five results. Show all on a group switches to its scope, where you get up to twenty-four.

Scopes that belong to a module

Some scopes only appear when the matching module is turned on for your server:

Timesheets only show up in search when advanced time tracking runs with approvals. When a module is off, its tab is not there at all.

Narrow it to one kind of thing

The tabs under the search field limit the search to one scope: All, Commands, Issues, Comments, Projects, Teams, People, Boards & Sprints, Knowledge, Attachments, Shifts, Time tracking, Absences, Billing.

The palette with the Knowledge scope picked and nothing typed The Knowledge scope with an empty field: the most recently touched articles, with their space and age.

Click a tab, or press Tab to move forward and Shift+Tab to move back. Your query stays in the field while you switch.

With an empty search field, each tab shows how many items you can see in that scope. From a hundred on it says "99+". Only what you may open is counted.

An empty query in a scope is a browse list

With no query, a scope shows the most recently touched items. It is the quickest way back to what the team worked on today.

Everything from the keyboard

KeyDoes
↑ / ↓Move through results, across group boundaries
↵ EnterOpen the selected result, or run the selected command
Tab / Shift+TabMove to the next / previous scope
EscClose the palette

The best match is already selected. Usually it is just: ⌘K, a few characters, Enter. Hovering a row with the mouse selects it too.

Read the results before you open them

Each row shows enough to spot the right result:

  • Issue: type glyph, key, a colored status dot with the status name, and the assignee's avatar on the right.
  • Project: a colored hexagon with the project key, how many issues are open and done, and its members.
  • Person: avatar and job title.
  • Board or sprint: the name, plus the goal for a sprint.
  • Article: its space and when it was last updated, so stale duplicates stand out.

Where a result takes you

Enter or a click takes you straight to the spot that matters:

ResultOpens
Issuethe issue
Commentthe issue, already scrolled to the comment
Attachmentthe issue with the attachment open
Projectthe issue list, filtered to that project
Teamthe team page
Personthe person profile
Boardthe board
Sprintthe board with that sprint selected
Articlethe article
Spacethe space
Shift planning eventthe event
Shiftthe event with that shift's sheet open
Your time entrythe time calendar on that day with the entry open. Without advanced time tracking you land on that week of the timesheet.
Your timesheetthe timesheet with its period and project
Your absence requestthe request
Absence typea new request of that type
Budgetthe project settings, in the time tracking section
Hourly ratethe hourly rates page with that rate open

Who finds what

Search only shows what you may open. Admins are no exception.

  • Issues, comments, attachments, projects and boards from projects you are a member of, plus issues shared with you.
  • Teams only those you are a member of.
  • Articles and spaces only when they are shared with you.
  • Time entries, timesheets and absence requests only your own. You will not find those of your colleagues here, not even as an organization admin.
  • Budgets of the projects you can see. A budget in money only shows up if you may see it: as an organization admin, or as a project lead when it is a revenue budget.
  • Hourly rates: organization admins see every personal, team and default rate, and the rates of the projects they can see. Project leads see the revenue rates of their projects. Only organization admins see cost rates.

The counts on the tabs follow the same rules. A scope never counts anything you could not open.

Recent searches

Open the palette with an empty field to see your last six search terms.

The palette showing recent searches with an empty query Recent searches, most recent first, with Clear on the right.

  • A term is only saved once you open one of its results.
  • Clicking a term puts it back in the field and runs the search again. It does not jump straight to a result.
  • Recents are stored per device, so your phone and laptop keep separate lists.

It is also a command bar

Type what you want to do and the palette offers it. Every page in the navigation can be found as a command:

  • Dashboard, Projects, Issues, Board, Timeline, Knowledge, Teams, Watched, Notifications and Weekly summary.
  • Reports. With advanced time tracking every tab can be found on its own, like Workload or Billing, as long as you may see it.
  • Timesheet, Time tracking with Calendar, Absences, Focus mode and Timer, plus Approvals when your organization has approvals turned on.
  • Log time and Ask for time off as actions.
  • Shifts with Calendar and Events, when shift planning is turned on.
  • Hourly rates and Invoices, when billing is turned on and you are an organization admin.
  • Settings and every section in it: Security, Sessions, Notifications, Time tracking, Access, Appearance, Data and Danger zone. Access tokens only exists when the MCP server is turned on.
  • Admin area with each of its sections, for admins only.
  • Organization with Holidays and Log, for organization admins only.

Each section shows which page it belongs to. That is how you tell Time tracking in the settings apart from the Time tracking page.

On top of that there are a few actions:

  • Create new issue: opens the board, where every column has an Add issue composer at its foot.
  • Toggle light / dark appearance: switches the theme. The palette stays open so you can switch back right away.

Commands are matched on your device and appear instantly. You do not have to type the label exactly: "dark", "theme" and "appearance" all find the theme switch.

Where the answers come from

All results except commands come from your own server. There is no external index, and nothing is sent anywhere else. Results are current: an issue renamed a minute ago is findable under its new title.

The app waits a moment after your last keystroke before asking, and discards outdated answers. So results do not flicker while you type. Even on a slow connection you never see results for car when you have already typed carbon.

When nothing comes back

Check in this order:

  1. Is a scope still active? A tab you picked stays active. Press All.
  2. Is it part of a long word? Partial text only matches titles, keys and labels, not descriptions and articles. Type the whole word.
  3. Is it archived? Put archived in front of the query.
  4. Can you reach it? Search only finds what you may open: issues and projects through project membership and your teams, knowledge base pages only when you may read them. Admins are no exception. If a colleague sees something you cannot, ask them to add you, or see Who finds what, Projects and teams and Who can see and change what.
  5. Is the whole scope missing? Shifts, absences and billing only appear when their module is turned on. See Scopes that belong to a module.

The palette on a phone

On a phone the palette fills the screen and slides down from the top. The field is at the top and the keyboard is already open. The scope tabs scroll sideways. The keyboard hint footer is left out.

Scopes, recents, the archive keyword and commands work as on a desktop. More in On your phone.

Six things people actually look for

"Someone mentioned HIN-42." Type the key. Case does not matter, and part of it is enough: hin-4 already narrows the list. Enter opens the top hit.

"I remember a phrase from the description, not the title." Type whole words, like "certificate rotation". Descriptions and article bodies are searched too. If nothing comes back, try just the most distinctive word. Long fields match word by word, not by fragments.

"I want everything in one project." Search for the project and press Enter. You land on the Issues list, already filtered to that project. Narrow it further with Filter and Group by.

"Has anyone picked this up?" Open Issues, then Filter → Assignee → Unassigned. Add Status if you only care about work that has started.

"What did I touch last week?" Filter → Assignee → you, Sort → Last modified (new), Time range → Last 7 days. If you work across several projects, group by project.

"Was this deleted?" Archived items are not gone. Type archived followed by your query, like archived login bug. The palette then searches archived issues and projects. archived on its own shows the most recently archived items. The German word archiviert works the same, whatever language your app uses.

Archived issues carry a badge

Results from the archive are marked. You restore them from the issue itself, see Working with issues.

Issue keys are addresses

Every issue has a permanent key: the project key, a dash and a number, like HIN-42. It is unique across the server and works well in chat messages, commits and documents.

  • In the web app, …/browse/HIN-42 opens the issue directly.
  • In the desktop and mobile apps, type the key into the palette.

If an issue moves to another project, it gets a new number. The old key keeps working: in the palette, in browse links, and in articles and issues that already mention it.

Click the key to copy a link

On an open issue, click its key to copy a link to the clipboard. A copy icon appears on hover, and the key confirms when done. The link opens the issue in the app where it is installed, and in the browser otherwise.

When you need a list, not a jump

The Issues page shows every issue in every project you have access to. Recently touched issues come first, and more load as you scroll. Four controls shape the list.

The Issues list with its Group by, Sort, Filter and Time range controls above the table The Issues page with its four controls above the table and Export on the right.

Reading a row

Each row shows the key, the title with a type glyph, status, priority, assignee and due date.

  • Due uses relative terms: 3d overdue and Today in red, then Tomorrow, then 5d for the coming week. After that it shows a date.
  • Title shows a counter like 0/1 or 3/4 when the issue has sub-tasks, so you can tell whether a parent is really done.

Click a row to open the issue.

Shaping the list

Filter opens a popover with five facets (Status, Priority, Assignee, Project, Type) and an Archived switch.

  • Within one facet it is OR: Bug and Task shows both.
  • Between facets it is AND: Bug plus In Progress plus Lena shows only Lena's in-progress bugs.

The Filter popover with the Assignee facet open One choice each in Status and Assignee: the footer reads 2 active, the header 3 of 11 issues.

Long facets have their own search field. Clear all in the footer empties every facet.

Group by splits the list into sections, like by assignee for a standup or by project. The button shows the name of the active grouping.

The Group by menu open above the issue list The Group by menu with a tick on the active grouping.

Sort orders the whole result set, not just the loaded rows: newest or oldest first, or by last modified. The default is most recently touched first.

Time range narrows by date:

  • With a start and a due date: matches when the span overlaps the range.
  • With only one date: matches when it falls inside the range.
  • With no date: uses when it was last touched.

The Time range menu open above the issue list Overdue and today at the top, rolling ranges in the middle, and Custom range… opens a calendar.

This button also shows the name of the active range.

Filters last for the visit, not forever

There are no saved views yet. Your settings last until you leave the page. For a view you need every day, keep the link (see below) or build a board, which saves its configuration.

Some links bring a filter with them. Clicking the Today's tasks tile on your dashboard opens the Issues list with everything due by today. The number on the tile matches the number of rows. A project card filters to its project the same way.

In the web app the filter is in the address bar. Copy the link and a colleague sees the same filtered list.

Taking the results with you

Export writes the complete filtered set, not just the loaded rows. The app first fetches every page from the server.

The Export menu open on the Issues toolbar The Export menu with three formats.

  • Export as PDF: a printable table with your organisation's name and logo.
  • Export as CSV: for spreadsheets.
  • Export as JSON: for tools that read the data back in.

The file lands in your Downloads folder. The app tells you the file name.

Work in Hinata is three levels deep: an epic holds stories, tasks, bugs and features, and these can hold sub-tasks. You can click through every level:

  • Every issue shows a breadcrumb above its title. The ancestors are clickable, from a sub-task to its parent and on to the epic.
  • A parent lists its child issues and sub-tasks in their own panels, with a progress count.
  • On a board, Group by → Epic gives one swimlane per epic. You see a whole initiative, including the parts nobody is working on.

The epic and parent pickers open with recent epics and recent issues listed first.

The person profile

You find people by display name, username and job title. "Vogt", "lvogt" and "designer" all find the same colleague. Clicking the result opens their profile.

In a wide window the profile slides in from the right as a side panel, and your current page stays behind it. On a phone it is a page of its own with a back button. Every profile has its own address (/people/<id>), so you can share the link and it opens the same profile.

What everyone sees

  • Picture, name and username, plus pronouns and job title when the person has filled them in.
  • Roles: admin, organization admin or member.
  • Shared teams and projects, the ones you are both in. On your own profile these are your teams and projects.
  • Time zone with the local time.
  • Absence today, when advanced time tracking is turned on and you may see this person's absences. With limited visibility you see vacation or "Other" and the dates, never a note. A sick note shows as "Other".

Below that are two actions:

  • This person's issues opens the issue list filtered to them as assignee. Narrow it further with Filter and Group by.
  • Write an email opens your mail app. It is only there when you may see the address. Right now that is admins only. There is no setting that makes addresses visible to everyone.

What admins see on top

Admins manage the person right in the profile, with the same options as under Admin area → Users:

  • Grant and remove roles, organization admin included.
  • Suspend the account or reactivate it.
  • Resend the invitation.
  • Reset the password.
  • End all sessions.
  • Look at the account's history.
  • Delete the account.

The rules for roles apply here too, see Organization.

Only admins see deactivated accounts

Only admins can open the profile of a deactivated account. Everyone else sees "This person isn't here", even with a link to it.

When you write a description, comment or article, type @ and pick the issue, article or person. You get a link that:

  • shows the issue's real title and status,
  • opens the issue when clicked,
  • fills the Linked issues panel (on the article) and Documented in (on the issue).

Typing HIN-42 as plain text does none of that. More in Writing documentation.

Finding things elsewhere

  • The board has its own filter with sprint, author, label and epic, plus a people filter. See Boards and sprints.
  • The knowledge base has a search field above its spaces, matching article titles, space names and labels. See Writing documentation.
  • Watched collects the issues you follow. See Staying informed.
  • Inside an issue, the @ menu searches issues, articles and people.

The rule of thumb

If you can name the thing, use ⌘K. If you can only describe it (open, mine, overdue), use the Issues list. If you need it again tomorrow, make it a board.

Next steps