Haruno Knowledge base

Playbooks

A Playbook is a saved set of instructions you run by typing a slash and its name. This page shows how to find one and run it in a chat on Windows.

  • Mac appAvailable
  • Windows appAvailable

A Playbook is a set of instructions you wrote once and want to reuse. "Review this company's month" is a good one. Instead of typing it again, you run the Playbook.

Every Playbook has a short name, such as month-review. You run it by typing a slash and that name in the message box.

To write your own, see Create and manage Playbooks.

Run a Playbook

  1. Type a slash

    Start a message with /. A small list of your Playbooks appears above the message box. Keep typing to narrow it down.

    Type / and the first letters of the name.
    The message box with /mo typed in it and one suggestion above it: month-review, Month review.The message box with /mo typed in it and one suggestion above it: month-review, Month review.
  2. Pick one

    Press Enter or Tab to choose the highlighted Playbook. This fills in the name. It does not send anything yet.

  3. Fill in what it asks for

    If the Playbook has no parameters, the message box now holds /month-review. Add any extra words after the name if you like, then press Enter to send.

    If it has parameters, a window opens with one field for each. Fill in every one and press Run.

A Playbook with a parameter asks for it before it runs. Will send shows exactly what Haruno receives.
A window titled Parameters: Month review. It shows one required field called company with Example Co typed in it, a Will send box showing the command, and the buttons Run and Cancel.A window titled Parameters: Month review. It shows one required field called company with Example Co typed in it, a Will send box showing the command, and the buttons Run and Cancel.

A parameter is a blank in the Playbook that you fill in each time, such as the name of the company. The Will send box shows what will go to Haruno. Run stays unavailable until every field has something in it. If Haruno is still answering, wait for it to finish or stop it first.

When a Playbook runs successfully, the chat shows a line above the answer that reads Used Playbook · title. Click it to open that Playbook in the Playbooks window. A Playbook that failed or did not finish shows no line.

The Activities panel has a Playbooks section. It lists each Playbook the session used, with its kind and how many times it ran. A Playbook that failed is still listed there, by its name.

Run one from the menu

The Playbooks menu in the menu bar lists your Recent Playbooks. Choose one to start it the same way as typing its name.

The Playbooks menu keeps your recent ones close.
The Playbooks menu with Manage Playbooks and, under Recent Playbooks, Review changes (/review).The Playbooks menu with Manage Playbooks and, under Recent Playbooks, Review changes (/review).

Manage Playbooks… opens the window where you create and edit them.

Built-in and learned Playbooks

The Playbooks window lists four kinds of Playbook. The slash list offers only the first two.

  • Yours and Project: the ones you wrote, as described below. Type / to run them.
  • Built into Haruno: Playbooks that come with the app. You can open one to read it, but you cannot change, copy or delete it. You cannot run one by typing its name, because each one needs details that only Haruno supplies.
  • Learned by Haruno: Playbooks Haruno saved for itself while it worked. You can open one, delete it, or press Keep as My Playbook to make it yours. Keeping it copies it into your list and removes it from the learned list. You cannot run one by typing its name, but Haruno can still use it on its own when it fits the task.

Each suggestion shows the name and the title. A person icon means a Personal Playbook that is yours in every project. A folder icon means it belongs to the current project. About five fit on screen at a time. Scroll for more.

Some Playbooks cannot be run right now, and the list says why:

The list saysWhat it means
Available in a new sessionThe Playbook was changed after this chat began. Choose Run in New Session to start a new chat that has the latest version.
Another Playbook or built-in command uses this nameGive your Playbook a different name.
Automatic use onlyHaruno can use this Playbook on its own. You cannot type it.
Good to know

Playbooks still work in a temporary chat. The slash list does not open when the message starts with a blank line, and it hides while a window or a full-width side panel is open.

Last updated · PR #2878 · View this version on GitHub

History (2 versions)
  1. Windows Playbooks: built-in and learned lists, Keep as mine, used-Playbook lines (#2856) (#2878)
    What changed
    @@ -8,6 +8,7 @@ covers:
       - windows-client/Haruno.Desktop.ViewModels/ChatViewModel.Playbooks.cs
       - windows-client/Haruno.Desktop.ViewModels/PlaybooksViewModel.cs
       - windows-client/Haruno.Desktop.Core/Playbooks/**
    +  - windows-client/docs/playbooks.md
     ---
     
     A **Playbook** is a set of instructions you wrote once and want to reuse. "Review this company's month" is a good one. Instead of typing it again, you run the Playbook.
    @@ -38,7 +39,9 @@ If it has parameters, a window opens with one field for each. Fill in every one
     
     A **parameter** is a blank in the Playbook that you fill in each time, such as the name of the company. The **Will send** box shows what will go to Haruno. **Run** stays unavailable until every field has something in it. If Haruno is still answering, wait for it to finish or stop it first.
     
    -When the Playbook runs, the chat shows a line that starts with *Ran Playbook* and names it.
    +When a Playbook runs successfully, the chat shows a line above the answer that reads **Used Playbook · title**. Click it to open that Playbook in the Playbooks window. A Playbook that failed or did not finish shows no line.
    +
    +The **Activities** panel has a **Playbooks** section. It lists each Playbook the session used, with its kind and how many times it ran. A Playbook that failed is still listed there, by its name.
     
     ## Run one from the menu
     
    @@ -48,7 +51,14 @@ The **Playbooks** menu in the menu bar lists your **Recent Playbooks**. Choose o
     
     **Manage Playbooks…** opens the window where you create and edit them.
     
    -## In the list
    +## Built-in and learned Playbooks
    +
    +The Playbooks window lists four kinds of Playbook. The slash list offers only the first two.
    +
    +- **Yours** and **Project**: the ones you wrote, as described below. Type `/` to run them.
    +- **Built into Haruno**: Playbooks that come with the app. You can open one to read it, but you cannot change, copy or delete it. You cannot run one by typing its name, because each one needs details that only Haruno supplies.
    +- **Learned by Haruno**: Playbooks Haruno saved for itself while it worked. You can open one, delete it, or press **Keep as My Playbook** to make it yours. Keeping it copies it into your list and removes it from the learned list. You cannot run one by typing its name, but Haruno can still use it on its own when it fits the task.
    +
     
     Each suggestion shows the name and the title. A person icon means a **Personal** Playbook that is yours in every project. A folder icon means it belongs to the current project. About five fit on screen at a time. Scroll for more.
     
    
  2. Internal knowledge base for staff: site, reader keys, assistant, 197 pages and the PR rule (#2944)
    What changed
    @@ -0,0 +1,65 @@
    +---
    +title: Playbooks
    +summary: A Playbook is a saved set of instructions you run by typing a slash and its name. This page shows how to find one and run it in a chat on Windows.
    +feature: playbooks
    +covers:
    +  - windows-client/haruno-webview/web/src/components/playbooks/**
    +  - windows-client/haruno-webview/Host/Contracts/WebPlaybooksAdapter.cs
    +  - windows-client/Haruno.Desktop.ViewModels/ChatViewModel.Playbooks.cs
    +  - windows-client/Haruno.Desktop.ViewModels/PlaybooksViewModel.cs
    +  - windows-client/Haruno.Desktop.Core/Playbooks/**
    +---
    +
    +A **Playbook** is a set of instructions you wrote once and want to reuse. "Review this company's month" is a good one. Instead of typing it again, you run the Playbook.
    +
    +Every Playbook has a short name, such as `month-review`. You run it by typing a slash and that name in the message box.
    +
    +To write your own, see [Create and manage Playbooks](/windows/chat/playbook-manager/).
    +
    +## Run a Playbook
    +
    +<Steps>
    +<Step title="Type a slash">
    +Start a message with **/**. A small list of your Playbooks appears above the message box. Keep typing to narrow it down.
    +
    +<Shot src="/m/53acc0e7c9cf-windows-chat-playbooks-complete-light.png" dark="/m/0c1a474c4c42-windows-chat-playbooks-complete-dark.png" alt="The message box with /mo typed in it and one suggestion above it: month-review, Month review." caption="Type / and the first letters of the name." />
    +</Step>
    +<Step title="Pick one">
    +Press **Enter** or **Tab** to choose the highlighted Playbook. This fills in the name. It does not send anything yet.
    +</Step>
    +<Step title="Fill in what it asks for">
    +If the Playbook has no parameters, the message box now holds `/month-review`. Add any extra words after the name if you like, then press **Enter** to send.
    +
    +If it has parameters, a window opens with one field for each. Fill in every one and press **Run**.
    +</Step>
    +</Steps>
    +
    +<Shot src="/m/f33eb196d6b3-windows-chat-playbooks-parameters-light.png" dark="/m/ff48dfaa99e2-windows-chat-playbooks-parameters-dark.png" alt="A window titled Parameters: Month review. It shows one required field called company with Example Co typed in it, a Will send box showing the command, and the buttons Run and Cancel." caption="A Playbook with a parameter asks for it before it runs. Will send shows exactly what Haruno receives." />
    +
    +A **parameter** is a blank in the Playbook that you fill in each time, such as the name of the company. The **Will send** box shows what will go to Haruno. **Run** stays unavailable until every field has something in it. If Haruno is still answering, wait for it to finish or stop it first.
    +
    +When the Playbook runs, the chat shows a line that starts with *Ran Playbook* and names it.
    +
    +## Run one from the menu
    +
    +The **Playbooks** menu in the menu bar lists your **Recent Playbooks**. Choose one to start it the same way as typing its name.
    +
    +<Shot src="/m/349898d974a2-windows-chat-playbooks-menu-light.png" dark="/m/44d1d539ad3c-windows-chat-playbooks-menu-dark.png" alt="The Playbooks menu with Manage Playbooks and, under Recent Playbooks, Review changes (/review)." caption="The Playbooks menu keeps your recent ones close." />
    +
    +**Manage Playbooks…** opens the window where you create and edit them.
    +
    +## In the list
    +
    +Each suggestion shows the name and the title. A person icon means a **Personal** Playbook that is yours in every project. A folder icon means it belongs to the current project. About five fit on screen at a time. Scroll for more.
    +
    +Some Playbooks cannot be run right now, and the list says why:
    +
    +| The list says | What it means |
    +|---|---|
    +| **Available in a new session** | The Playbook was changed after this chat began. Choose **Run in New Session** to start a new chat that has the latest version. |
    +| **Another Playbook or built-in command uses this name** | Give your Playbook a different name. |
    +| **Automatic use only** | Haruno can use this Playbook on its own. You cannot type it. |
    +
    +<Callout variant="info" title="Good to know">
    +Playbooks still work in a temporary chat. The slash list does not open when the message starts with a blank line, and it hides while a window or a full-width side panel is open.
    +</Callout>