Haruno Knowledge base

Playbooks

A Playbook is a set of instructions you save once and run with a slash command. The Playbooks window is where you write, change and delete them.

  • Mac appAvailable
  • Windows appAvailable

A Playbook is a reusable set of instructions you run with a slash command. Write down how you like a task done once, for example "check this month's close and draft the email", then run it in any chat by typing its name.

Run a Playbook

  1. Type a slash

    Type / at the very start of the message. A list of your Playbooks appears. Each row shows the command and its description. Keep typing to narrow the list. If nothing matches, it says No matching Playbooks.

  2. Pick one

    Move with the arrow keys and press Return or Tab, or click a row. Esc closes the list. Picking never sends the message. The command goes into the box, for example /monthly-review.

  3. Add words, then send

    Type anything you want to add after the command and press Return. If the Playbook has parameters, a form opens instead. See below.

There is another way. Click the plus button beside the message box. Recent Playbooks lists the last five you ran. Picking one puts its command in the box, replacing what was there, and does not send it. These choices are off while Haruno is working.

Playbooks with parameters

A Playbook can ask for named values, such as a company name and a month. When you pick one, a form opens with its title, its description and a box for each parameter. Under Will send it shows the exact message Haruno will get. Fill in every box and click Run. The button waits while Haruno is still answering.

When a Playbook is new

A chat that has already started may not know about a Playbook you created after it began. The list marks it with a small clock, and a note above the message box says it is ready in your next chat. Start New Chat in the note starts one, and what you typed stays. In the form the button reads Run in New Chat and says running it clears the transcript.

The Playbooks window

Click the plus button and choose Manage Playbooks…. A window opens with your Playbooks in a list on the left. Each row shows the title and the command. A filter box appears once the list is long. Pick one to read it on the right: its description, its parameters, a usage hint, when to use it, and where it is saved.

The toolbar has:

  • New Playbook
  • Edit
  • Duplicate to Yours
  • Reveal in Finder
  • Delete, which moves it to the Trash. You can put it back from Finder.

With no Playbooks, the window says No Playbooks yet and offers New Playbook….

Write a Playbook

Click New Playbook. The sheet has these fields.

FieldWhat to put
CommandThe name you type after the slash. Letters, numbers, hyphens and underscores. Up to 64 characters. It cannot be one that already exists
Display nameOptional. What the lists show. It does not change the command
DescriptionOptional. It also helps Haruno decide when to use the Playbook by itself
InstructionsWhat Haruno should do, written in plain text with Markdown. Use $name for a parameter, or $ARGUMENTS for everything typed after the command
ParametersOptional. Names separated by spaces. They become boxes in the form
Usage hint, When to useOptional notes

The sheet shows Type /name in chat to run this. under the command. Click Save. The Playbook is saved on your Mac, in one library for all your chats.

To change one, select it and click Edit. Renaming it moves it, and the old command stops working. The sheet warns you. Duplicate to Yours copies a Playbook so you can change the copy.

If a name is not allowed, the sheet says why, for example "name" already exists. or Use letters, numbers, hyphens and underscores, starting with a letter or number.

Playbooks that come with Haruno

Haruno has a few Playbooks of its own that the assistant uses by itself, for example to read a company's books correctly. You do not see them in the Playbooks window and you cannot change or delete them. If you ask Haruno to change one, it says it cannot, and offers to keep what you want as a Playbook of your own.

Who has it

Everyone, in the normal view and the advanced view.

What to tell a customer

If a customer finds they ask Haruno for the same thing every month, a Playbook saves them retyping it. They write the steps once, then type a slash and the name.

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

History (1 version)
  1. Internal knowledge base for staff: site, reader keys, assistant, 197 pages and the PR rule (#2944)
    What changed
    @@ -0,0 +1,85 @@
    +---
    +title: Playbooks
    +summary: A Playbook is a set of instructions you save once and run with a slash command. The Playbooks window is where you write, change and delete them.
    +feature: playbooks
    +covers:
    +  - apple/Sources/PlaybookFeature/**
    +  - apple/Sources/PlaybookKit/**
    +  - apple/Sources/ChatUI/PlaybookPickerView.swift
    +  - apple/Sources/ChatUI/PlaybookParametersSheet.swift
    +  - apple/Sources/ChatUI/PlaybookPendingBanner.swift
    +  - apple/Sources/ChatUI/PlaybooksNavigator.swift
    +  - apple/Sources/ChatFeature/ChatModel+Playbooks.swift
    +  - apple/Sources/EngineSupport/PlaybookName.swift
    +---
    +
    +A Playbook is a reusable set of instructions you run with a slash command. Write down how you like a task done once, for example "check this month's close and draft the email", then run it in any chat by typing its name.
    +
    +## Run a Playbook
    +
    +<Steps>
    +<Step title="Type a slash">
    +Type <Ui>/</Ui> at the very start of the message. A list of your Playbooks appears. Each row shows the command and its description. Keep typing to narrow the list. If nothing matches, it says <Ui>No matching Playbooks</Ui>.
    +</Step>
    +<Step title="Pick one">
    +Move with the arrow keys and press <Ui>Return</Ui> or <Ui>Tab</Ui>, or click a row. <Ui>Esc</Ui> closes the list. Picking never sends the message. The command goes into the box, for example <Ui>/monthly-review</Ui>.
    +</Step>
    +<Step title="Add words, then send">
    +Type anything you want to add after the command and press <Ui>Return</Ui>. If the Playbook has parameters, a form opens instead. See below.
    +</Step>
    +</Steps>
    +
    +There is another way. Click the plus button beside the message box. <Ui>Recent Playbooks</Ui> lists the last five you ran. Picking one puts its command in the box, replacing what was there, and does not send it. These choices are off while Haruno is working.
    +
    +## Playbooks with parameters
    +
    +A Playbook can ask for named values, such as a company name and a month. When you pick one, a form opens with its title, its description and a box for each parameter. Under <Ui>Will send</Ui> it shows the exact message Haruno will get. Fill in every box and click <Ui>Run</Ui>. The button waits while Haruno is still answering.
    +
    +## When a Playbook is new
    +
    +A chat that has already started may not know about a Playbook you created after it began. The list marks it with a small clock, and a note above the message box says it is ready in your next chat. <Ui>Start New Chat</Ui> in the note starts one, and what you typed stays. In the form the button reads <Ui>Run in New Chat</Ui> and says running it clears the transcript.
    +
    +## The Playbooks window
    +
    +Click the plus button and choose <Ui>Manage Playbooks…</Ui>. A window opens with your Playbooks in a list on the left. Each row shows the title and the command. A filter box appears once the list is long. Pick one to read it on the right: its description, its parameters, a usage hint, when to use it, and where it is saved.
    +
    +The toolbar has:
    +
    +- <Ui>New Playbook</Ui>
    +- <Ui>Edit</Ui>
    +- <Ui>Duplicate to Yours</Ui>
    +- <Ui>Reveal in Finder</Ui>
    +- <Ui>Delete</Ui>, which moves it to the Trash. You can put it back from Finder.
    +
    +With no Playbooks, the window says <Ui>No Playbooks yet</Ui> and offers <Ui>New Playbook…</Ui>.
    +
    +## Write a Playbook
    +
    +Click <Ui>New Playbook</Ui>. The sheet has these fields.
    +
    +| Field | What to put |
    +|---|---|
    +| <Ui>Command</Ui> | The name you type after the slash. Letters, numbers, hyphens and underscores. Up to 64 characters. It cannot be one that already exists |
    +| <Ui>Display name</Ui> | Optional. What the lists show. It does not change the command |
    +| <Ui>Description</Ui> | Optional. It also helps Haruno decide when to use the Playbook by itself |
    +| <Ui>Instructions</Ui> | What Haruno should do, written in plain text with Markdown. Use <Ui>$name</Ui> for a parameter, or <Ui>$ARGUMENTS</Ui> for everything typed after the command |
    +| <Ui>Parameters</Ui> | Optional. Names separated by spaces. They become boxes in the form |
    +| <Ui>Usage hint</Ui>, <Ui>When to use</Ui> | Optional notes |
    +
    +The sheet shows <Ui>Type /name in chat to run this.</Ui> under the command. Click <Ui>Save</Ui>. The Playbook is saved on your Mac, in one library for all your chats.
    +
    +To change one, select it and click <Ui>Edit</Ui>. Renaming it moves it, and the old command stops working. The sheet warns you. <Ui>Duplicate to Yours</Ui> copies a Playbook so you can change the copy.
    +
    +If a name is not allowed, the sheet says why, for example <Ui>"name" already exists.</Ui> or <Ui>Use letters, numbers, hyphens and underscores, starting with a letter or number.</Ui>
    +
    +## Playbooks that come with Haruno
    +
    +Haruno has a few Playbooks of its own that the assistant uses by itself, for example to read a company's books correctly. You do not see them in the Playbooks window and you cannot change or delete them. If you ask Haruno to change one, it says it cannot, and offers to keep what you want as a Playbook of your own.
    +
    +## Who has it
    +
    +Everyone, in the normal view and the advanced view.
    +
    +## What to tell a customer
    +
    +If a customer finds they ask Haruno for the same thing every month, a Playbook saves them retyping it. They write the steps once, then type a slash and the name.