@springbrand/hr-cli 0.3.0 → 0.5.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: saas-hr-cli
3
- description: Use the `hr` command to work with SpringBrand HR (recruiting) on the user's behalf: jobs, the talent pool, screening, interview scheduling and approvals. Use when the user asks about candidates, resumes, open roles, screening or interviews.
3
+ description: Use the `hr` command to work with SpringBrand HR (recruiting) on the user's behalf: jobs, the talent pool and resumes, screening, moving applications, booking interviews (the meeting itself comes from another tool), candidates' replies and mail, evaluations, reports, approvals, and HR's settings (pipelines, scorecards, templates, mailboxes). Use when the user asks about candidates, resumes, open roles, screening, interviews, replies or how recruiting is set up.
4
4
  ---
5
5
 
6
6
  # hr CLI
@@ -26,6 +26,35 @@ The rules below are what the help cannot tell you.
26
26
  - `APP_CONFLICT` means the state changed, for example the candidate was already screened. List again.
27
27
  - `APP_FORBIDDEN` means the caller lacks the permission and it cannot be approved. It is granted in IAM.
28
28
 
29
+ ## Interviews, meetings and calendars
30
+
31
+ - HR connects to no meeting platform or calendar. When the user wants an online interview, first create the meeting with the tool you have for the user (Feishu, Tencent Meeting, Zoom…), then book it in HR with that meeting's link (and its ID) as the place. For an in-person interview, pass the address.
32
+ - Booking (and moving) an interview may mail the candidate an invitation with the time, place and link, when the job's stage is set to. Say so to the user only when `data.invite` says it was sent; `pendingApproval` there means the invitation waits for a person in IAM, though the interview is booked.
33
+ - HR then waits for the candidate's answer, reminds them and gives up on its own, as the stage says. Never mail the candidate a second invitation yourself.
34
+ - When an interview moves or is cancelled, change HR first (`reschedule`, `cancel`), then the meeting and any calendar event.
35
+ - Pass times with the user's UTC offset. If you do not know their time zone, ask. Never let a bare "3 pm" be read in some other zone.
36
+ - Interviewers are people. Without names, the stage's default interviewers are used, or else the job's; when the user says "me", find the user with `hr people search`.
37
+
38
+ ## Replies and evaluations
39
+
40
+ - HR reads candidates' replies to invitations itself. What it was sure of is already done; `hr replies list` is what still needs a person: another time asked for, unclear replies, mail it could not tie to one interview.
41
+ - Answer a reply only when the user asks, with the user's own words or a draft they approved. Mailing the candidate marks their replies dealt with.
42
+ - Submit an evaluation only for the user's own interview, with the verdict and reasons the user gave. Never choose a verdict for them.
43
+
44
+ ## What cannot be taken back
45
+
46
+ - Erasing a talent, merging two talents, deleting a mailbox, a pool, a tag or a job board rule, and removing or rotating the webhook are final. Do them only when the user asked for that exact record, after saying what will happen and hearing yes.
47
+ - Rejecting or withdrawing an application closes it (it can be reopened). Do it only about a specific person the user named.
48
+
49
+ ## Settings
50
+
51
+ - `pipelines save` and `scorecards save` replace the whole list of stages or criteria. Start from `show`, change only what the user asked for, and tell them what changed.
52
+ - Never ask for or repeat a mailbox password or the webhook secret in the conversation. A mailbox password comes from the user's own environment.
53
+
54
+ ## Mail
55
+
56
+ - `mail draft` writes nothing to anyone. Show the draft to the user; send it with `mail send` only after they approve it.
57
+
29
58
  ## Approvals
30
59
 
31
60
  Without the permission, a change waits for a person in IAM, and the command answers with `data.pendingApproval: { approvalId }`. **The action has not happened yet.** Do not say the candidate was rejected. Tell the user it is waiting for approval, then check when asked, or wait with `hr approvals status <approvalId> --wait`.
package/README.md CHANGED
@@ -3,7 +3,8 @@
3
3
  The `hr` command for SpringBrand HR, for people and Agents. Output is JSON on stdout.
4
4
 
5
5
  ```bash
6
- npm i -g @springbrand/hr-cli
6
+ npm i -g @springbrand/hr-cli # the stable release
7
+ npm i -g @springbrand/hr-cli@alpha # the newest alpha, ahead of the deployed HR
7
8
  export HR_API_URL=https://your-hr-address
8
9
  hr login
9
10
  hr screening list
@@ -21,4 +22,8 @@ hr screening list
21
22
 
22
23
  Talents and applications in the output carry `url`, their page in the HR console, on the address HR reports.
23
24
 
24
- `hr --help` lists the commands. Agents: see `.agents/skills/saas-hr-cli/SKILL.md`.
25
+ `hr --help` lists every command by group; `hr <group> --help` (for example `hr talents --help`) shows a
26
+ group with what each command takes and returns. The CLI covers the whole HR API: a test fails when an
27
+ API route has no command. Fields a command has no flag for go in `--json '{…}'` or `--json @file.json`.
28
+
29
+ Agents: see `.agents/skills/saas-hr-cli/SKILL.md`.