Lesson 7 of 7 · HQ fundamentals
Create, Train, and Share a Reusable HQ Worker
Build a worker for one job, see the files that make it up, teach it your look, and share it with your team.
- Written path
- 9 steps
Before You Begin
HQ is installed and you can start a session for your company.
You’re allowed to create workers for the company.
A public website whose look you’d like the worker’s pages to follow.
To share it: your company is set up for your team (see Lesson 2) and your teammate is a member.
Step-by-step walkthrough
Step 1: Pick one job
A worker does one repeatable job well instead of trying to do everything. This lesson builds a landing-page generator. It has a role, skills, knowledge, and examples, and it gets better as you add to them.
ExpectedYou know what job your worker does and how it’s different from a single skill.
Step 2: Create the worker
Start a session for your company, then run /newworker with a short name for the job.
CommandType exactly as shown/startwork awesomeco/newworker landing-page-generatorExpectedHQ starts building the worker and asks a few questions.
Step 3: Answer HQ’s setup questions
Answer in your own words. In this example: keep it to AwesomeCo, have it build pages you can publish, and run it when you ask.
PromptSend in your AI sessionAwesomeCo onlyDeployable page (code)On-demandExpectedHQ creates the Landing Page Generator for your company.
Step 4: Look at the worker’s files
Open the worker’s folder and look at its settings file, readme, and landing-page skill.
Go toOpen this placeworker.yamlREADME.mdskills/generate-landing-page.mdExpectedYou can see what the worker does, how it runs, and which skill it uses.
Step 5: Teach it your look
Point HQ at a website you like and ask it to save the design style for this worker.
PromptSend in your AI sessionI want this worker to have more specific design instructions. Please reference hqforwork.com and build a design and aesthetic pack this worker can use.ExpectedHQ reads the site and asks how closely new pages should follow it.
Step 6: Choose how closely to match it
Once HQ has read the site, pick how closely the worker’s pages should match it.
ChoosePick this in HQSelect Match it closelyExpectedHQ saves the design style and builds it into the worker, so it’s used every time.
Step 7: Check that it stuck
Make sure the design pack is saved in your company’s knowledge, and that the worker’s settings and skill both point to it.
Go toOpen this placecompanies/[company]/knowledge/design/hq-aesthetic-pack.mdworker.yamlskills/generate-landing-page.mdExpectedEvery time the worker runs, it starts from your saved design style.
Step 8: Share it and hand off
Ask HQ to share the worker with a teammate, send them a DM, and wrap up with a handoff.
PromptSend in your AI sessionShare this worker with [teammate], send an HQ DM, and hand off.ExpectedYour teammate can use the same worker and design style, and your session is saved.
Step 9: Run it and keep making it better
Run the worker whenever you need a new page. When your team finds a better way to do something, add it to the worker’s skills, design pack, or examples.
CommandType exactly as shown/run landing-page-generator generate-landing-pageExpectedEach run uses everything your team has taught it so far.
You’re done when
Your worker exists, it uses your saved design style every time, and your teammate can use it and improve it too.
Hit a snag? Here’s the fix.
My teammate can’t see the worker
Sharing only reaches teammates when your company is set up for your team. Check they’re a member, then have them run /hq-sync.
/run says it can’t find the worker
Start the session in the company that owns the worker with /startwork [company], then try again. Company workers only show up inside their own company.
The worker ignores the aesthetic pack
Ask HQ to check that worker.yaml and the skill both point at the pack file. If one of them doesn’t, ask HQ to add the reference.
Something else going on? The HQ knowledge base walks through the most common fixes, or reach out and we’ll help you get unstuck.