bamboohr-cli 1.0.14 → 1.0.15
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.
- package/README.md +91 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# bamboohr-cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for the [BambooHR API](https://documentation.bamboohr.com/reference). 17 commands across 4 domains — employees, time off, files, and metadata.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g bamboohr-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
Set two environment variables in your shell profile:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
export BAMBOO_TOKEN="your-api-token" # BambooHR > Settings > API Keys
|
|
17
|
+
export BAMBOO_COMPANY_DOMAIN="mycompany" # the subdomain in mycompany.bamboohr.com
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
All commands output JSON. Add `--pretty` to pretty-print.
|
|
23
|
+
|
|
24
|
+
### employee
|
|
25
|
+
|
|
26
|
+
| Command | Description |
|
|
27
|
+
|---------|-------------|
|
|
28
|
+
| `bamboohr employee get [id]` | Get employee by ID (defaults to current user) |
|
|
29
|
+
| `bamboohr employee search [query]` | Search employees by name, supervisor, department, location, division |
|
|
30
|
+
| `bamboohr employee directory` | Get the full company directory |
|
|
31
|
+
| `bamboohr employee photo <id>` | Download employee photo (`--size`: original, large, medium, small, xs, tiny) |
|
|
32
|
+
| `bamboohr employee goals <id>` | Get performance goals (`--status`: open, closed, all) |
|
|
33
|
+
|
|
34
|
+
### timeoff
|
|
35
|
+
|
|
36
|
+
| Command | Description |
|
|
37
|
+
|---------|-------------|
|
|
38
|
+
| `bamboohr timeoff types` | List time off types (`--requestable` to filter) |
|
|
39
|
+
| `bamboohr timeoff create [employeeId]` | Create a time off request (defaults to current user) |
|
|
40
|
+
| `bamboohr timeoff requests` | List requests (`--status`, `--start`, `--end`, `--employee`, `--type`) |
|
|
41
|
+
| `bamboohr timeoff balance [employeeId]` | Estimate time off balance (`--end` to project to future date) |
|
|
42
|
+
| `bamboohr timeoff whos-out` | View who's out today and upcoming |
|
|
43
|
+
| `bamboohr timeoff update-status <requestId>` | Approve, deny, or cancel a request |
|
|
44
|
+
|
|
45
|
+
### file
|
|
46
|
+
|
|
47
|
+
| Command | Description |
|
|
48
|
+
|---------|-------------|
|
|
49
|
+
| `bamboohr file list` | List all company files and categories |
|
|
50
|
+
| `bamboohr file get <fileId>` | Download a company file |
|
|
51
|
+
|
|
52
|
+
### meta
|
|
53
|
+
|
|
54
|
+
| Command | Description |
|
|
55
|
+
|---------|-------------|
|
|
56
|
+
| `bamboohr meta fields` | List all available BambooHR fields |
|
|
57
|
+
| `bamboohr meta departments` | List all departments |
|
|
58
|
+
| `bamboohr meta locations` | List all office locations |
|
|
59
|
+
| `bamboohr meta divisions` | List all divisions |
|
|
60
|
+
|
|
61
|
+
## Pagination
|
|
62
|
+
|
|
63
|
+
List commands accept `--limit` to control page size. Responses include a `nextPage` token — pass it back as `--offset` to fetch the next page. When `nextPage` is `null`, there are no more results.
|
|
64
|
+
|
|
65
|
+
## Examples
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
# Look up your own employee record
|
|
69
|
+
bamboohr employee get
|
|
70
|
+
|
|
71
|
+
# Find someone by name
|
|
72
|
+
bamboohr employee search "Jane"
|
|
73
|
+
|
|
74
|
+
# Filter by supervisor (use "me" for your direct reports)
|
|
75
|
+
bamboohr employee search --supervisor me
|
|
76
|
+
|
|
77
|
+
# Download a photo
|
|
78
|
+
bamboohr employee photo 123 --output ./photo.jpg --size large
|
|
79
|
+
|
|
80
|
+
# Check who's out this week
|
|
81
|
+
bamboohr timeoff whos-out
|
|
82
|
+
|
|
83
|
+
# Request a day off
|
|
84
|
+
bamboohr timeoff create --start 2026-04-20 --end 2026-04-20 --type-id 83 --amount 1
|
|
85
|
+
|
|
86
|
+
# See pending requests for approval
|
|
87
|
+
bamboohr timeoff requests --status requested --start 2026-01-01 --end 2026-12-31
|
|
88
|
+
|
|
89
|
+
# List available fields for custom queries
|
|
90
|
+
bamboohr meta fields
|
|
91
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bamboohr-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.15",
|
|
4
4
|
"publish": true,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
],
|
|
13
13
|
"dependencies": {
|
|
14
14
|
"commander": "^13.1.0",
|
|
15
|
-
"bamboohr-client": "1.0.
|
|
15
|
+
"bamboohr-client": "1.0.22"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"@types/node": "24.10.4",
|