talentprism-cli 0.3.0__tar.gz
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.
- talentprism_cli-0.3.0/PKG-INFO +93 -0
- talentprism_cli-0.3.0/README.md +243 -0
- talentprism_cli-0.3.0/pyproject.toml +73 -0
- talentprism_cli-0.3.0/setup.cfg +4 -0
- talentprism_cli-0.3.0/talentprism_cli/LICENSE.txt +17 -0
- talentprism_cli-0.3.0/talentprism_cli/README.md +70 -0
- talentprism_cli-0.3.0/talentprism_cli/__init__.py +1 -0
- talentprism_cli-0.3.0/talentprism_cli/__main__.py +5 -0
- talentprism_cli-0.3.0/talentprism_cli/auth.py +222 -0
- talentprism_cli-0.3.0/talentprism_cli/cli.py +1158 -0
- talentprism_cli-0.3.0/talentprism_cli/config.py +311 -0
- talentprism_cli-0.3.0/talentprism_cli/config_store.py +144 -0
- talentprism_cli-0.3.0/talentprism_cli/credentials.py +154 -0
- talentprism_cli-0.3.0/talentprism_cli/errors.py +48 -0
- talentprism_cli-0.3.0/talentprism_cli/format.py +96 -0
- talentprism_cli-0.3.0/talentprism_cli/loopback.py +143 -0
- talentprism_cli-0.3.0/talentprism_cli/network_bootstrap.py +113 -0
- talentprism_cli-0.3.0/talentprism_cli/oauth.py +193 -0
- talentprism_cli-0.3.0/talentprism_cli/readonly_api.py +327 -0
- talentprism_cli-0.3.0/talentprism_cli/sequence_writes.py +74 -0
- talentprism_cli-0.3.0/talentprism_cli/skill.py +165 -0
- talentprism_cli-0.3.0/talentprism_cli/transport.py +277 -0
- talentprism_cli-0.3.0/talentprism_cli.egg-info/PKG-INFO +93 -0
- talentprism_cli-0.3.0/talentprism_cli.egg-info/SOURCES.txt +26 -0
- talentprism_cli-0.3.0/talentprism_cli.egg-info/dependency_links.txt +1 -0
- talentprism_cli-0.3.0/talentprism_cli.egg-info/entry_points.txt +2 -0
- talentprism_cli-0.3.0/talentprism_cli.egg-info/requires.txt +2 -0
- talentprism_cli-0.3.0/talentprism_cli.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: talentprism-cli
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Command line for TalentPrism: team-scoped recruiting data and actions for people and AI agents
|
|
5
|
+
License-Expression: LicenseRef-Proprietary
|
|
6
|
+
Project-URL: Homepage, https://talentprism.ai
|
|
7
|
+
Project-URL: Documentation, https://talentprism.ai/help/talentprism-cli/
|
|
8
|
+
Keywords: talentprism,recruiting,cli,agents
|
|
9
|
+
Classifier: Environment :: Console
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Operating System :: OS Independent
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Topic :: Office/Business
|
|
17
|
+
Requires-Python: >=3.11
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: talentprism_cli/LICENSE.txt
|
|
20
|
+
Requires-Dist: PyYAML>=6.0.0
|
|
21
|
+
Requires-Dist: requests>=2.32.0
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# TalentPrism CLI
|
|
25
|
+
|
|
26
|
+
`tp` is the command line for TalentPrism. It reads team-scoped recruiting data (sequences, candidates, interviews, reminders, campaign and activity summaries, evidence records) and makes changes through the same permissions and validation as the web app. It prints JSON that scripts and AI agents can parse, and reports errors as structured JSON with a stable `code`.
|
|
27
|
+
|
|
28
|
+
Full documentation: https://talentprism.ai/help/talentprism-cli/
|
|
29
|
+
|
|
30
|
+
## Install
|
|
31
|
+
|
|
32
|
+
```shell
|
|
33
|
+
pipx install talentprism-cli
|
|
34
|
+
# or
|
|
35
|
+
uv tool install talentprism-cli
|
|
36
|
+
|
|
37
|
+
tp --version
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Requires Python 3.11 or newer.
|
|
41
|
+
|
|
42
|
+
## Sign in
|
|
43
|
+
|
|
44
|
+
People sign in with the browser:
|
|
45
|
+
|
|
46
|
+
```shell
|
|
47
|
+
tp login
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Pick a team and approve. The CLI keeps short-lived tokens in `~/.talentprism/config.toml` and refreshes them on its own. Use `tp login --no-browser` over SSH, and `tp logout` to sign out.
|
|
51
|
+
|
|
52
|
+
Scripts, CI jobs and AI agents use a team-scoped API key instead:
|
|
53
|
+
|
|
54
|
+
```shell
|
|
55
|
+
export TALENTPRISM_API_KEY="<your api key>"
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
New API keys expire one year after they are created. Your account page shows each key's expiry date and when it was last used; create a replacement key before the old one expires.
|
|
59
|
+
|
|
60
|
+
When several credentials are present, `tp` uses the first of: the `--api-key` flag, `TALENTPRISM_API_KEY`, login tokens in the profile, `api_key` in the profile. The server is `https://talentprism.ai` unless you set `TALENTPRISM_BASE_URL` (local development only).
|
|
61
|
+
|
|
62
|
+
## Examples
|
|
63
|
+
|
|
64
|
+
```shell
|
|
65
|
+
tp whoami
|
|
66
|
+
tp sequences list --status Active --json
|
|
67
|
+
tp candidates search --query "aircraft assembler North Charleston" --json
|
|
68
|
+
tp activity summary --days 14 --json
|
|
69
|
+
tp candidates timeline <candidate_id> --days 30 --json
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Changing data
|
|
73
|
+
|
|
74
|
+
Every write is two steps. Run the command once to get a preview and a one-time approval token. Nothing changes. Then run the same command again with `--confirm-write --approval-token <token>`:
|
|
75
|
+
|
|
76
|
+
```shell
|
|
77
|
+
tp candidates add-note 123 --text "Prefers second shift"
|
|
78
|
+
tp candidates add-note 123 --text "Prefers second shift" --confirm-write --approval-token <token>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Rate limits
|
|
82
|
+
|
|
83
|
+
Per credential (each API key, or each login), per minute: 300 reads, 60 changes, and 30 copilot questions (`tp copilot ask` and `tp copilot brief`). Previews count as reads. When a limit is hit the CLI reports `rate_limited` with a `retry_after` value.
|
|
84
|
+
|
|
85
|
+
## Help
|
|
86
|
+
|
|
87
|
+
- `tp --help` and `tp <command> --help` list every command and flag.
|
|
88
|
+
- `tp skill print` prints the agent skill text bundled with the CLI.
|
|
89
|
+
- Errors come with a `remediation` line. The help page has a troubleshooting table keyed by error code.
|
|
90
|
+
|
|
91
|
+
## License
|
|
92
|
+
|
|
93
|
+
Proprietary. The CLI is provided for use with a TalentPrism account; see `LICENSE.txt` in the package.
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
# Fleet
|
|
2
|
+
|
|
3
|
+
Candidate engagement and evaluation for recruiting and staffing agencies
|
|
4
|
+
|
|
5
|
+
## TalentPrism CLI
|
|
6
|
+
|
|
7
|
+
The Python `tp` CLI gives agents and humans a stable API-backed shell surface for TalentPrism reads and safe draft sequence creation. Install it with:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pipx install talentprism-cli
|
|
11
|
+
uv tool install talentprism-cli
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Authenticate with `TALENTPRISM_API_KEY`. Use `TALENTPRISM_BASE_URL` for staging, production, or local fleetapp, and `TALENTPRISM_PROFILE` when using named profiles from `~/.talentprism/config.toml`.
|
|
15
|
+
|
|
16
|
+
Common commands:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
tp whoami --output json
|
|
20
|
+
tp sequences list --status Active --output json
|
|
21
|
+
tp candidates list --sequence <uuid> --output json
|
|
22
|
+
tp interviews show <uuid> --output json
|
|
23
|
+
tp metrics --sequence <uuid> --output json
|
|
24
|
+
tp sequences create --file sequence.yaml --dry-run
|
|
25
|
+
tp skill print
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Output defaults to JSON when piped and table output on a TTY. Use `--output json|yaml|table|csv` to force a format. Successful data goes to stdout; errors are JSON on stderr with `code`, `type`, `message`, `details`, and `remediation`.
|
|
29
|
+
|
|
30
|
+
Exit codes: `0` success, `2` invalid input, `3` auth, `4` not found, `5` validation, `6` transient failure, `7` schema mismatch.
|
|
31
|
+
|
|
32
|
+
The CLI reads data and creates or repairs draft sequences only. It does not send outreach, trigger calls, activate sequences, mutate candidates, or bypass Django permissions/team scoping.
|
|
33
|
+
|
|
34
|
+
## Installation - Docker
|
|
35
|
+
|
|
36
|
+
The easiest way to get up and running is with [Docker](https://www.docker.com/).
|
|
37
|
+
|
|
38
|
+
Just [install Docker](https://www.docker.com/get-started) and
|
|
39
|
+
[Docker Compose](https://docs.docker.com/compose/install/)
|
|
40
|
+
and then run:
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
make init
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
This will spin up a database, web worker, celery worker, and Redis broker and run your migrations.
|
|
47
|
+
|
|
48
|
+
You can then go to [localhost:8000](http://localhost:8000/) to view the app.
|
|
49
|
+
|
|
50
|
+
*Note: if you get an error, make sure you have a `.env` file, or create one based on `.env.example`.*
|
|
51
|
+
|
|
52
|
+
### Using the Makefile
|
|
53
|
+
|
|
54
|
+
You can run `make` to see other helper functions, and you can view the source
|
|
55
|
+
of the file in case you need to run any specific commands.
|
|
56
|
+
|
|
57
|
+
For example, you can run management commands in containers using the same method
|
|
58
|
+
used in the `Makefile`. E.g.
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
docker compose exec web python manage.py createsuperuser
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Installation - Native
|
|
65
|
+
|
|
66
|
+
You can also install/run the app directly on your OS using the instructions below.
|
|
67
|
+
Setup a virtualenv and install requirements
|
|
68
|
+
(this example uses [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)):
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
mkvirtualenv fleet -p python3.11
|
|
72
|
+
pip install -r dev-requirements.txt
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Set up database
|
|
76
|
+
|
|
77
|
+
*If you are using Docker you can skip these steps.*
|
|
78
|
+
|
|
79
|
+
Create a database named `fleet`.
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
createdb fleet
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Create database migrations:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
python manage.py makemigrations
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Create database tables:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
python manage.py migrate
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Running server
|
|
98
|
+
|
|
99
|
+
**Docker:**
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
make start
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**Native:**
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
python manage.py runserver
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Building front-end
|
|
112
|
+
|
|
113
|
+
To build JavaScript and CSS files, first install npm packages:
|
|
114
|
+
|
|
115
|
+
**Docker:**
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
make npm-install
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**Native:**
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
npm install
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Then build (and watch for changes locally):
|
|
128
|
+
|
|
129
|
+
**Docker:**
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
make npm-watch
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
**Native:**
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
npm run dev-watch
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Running Celery
|
|
142
|
+
|
|
143
|
+
Celery can be used to run background tasks.
|
|
144
|
+
If you use Docker it will start automatically.
|
|
145
|
+
|
|
146
|
+
You can run it using:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
celery -A fleet worker -l INFO --pool=solo
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Or with celery beat (for scheduled tasks):
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
celery -A fleet worker -l INFO -B --pool=solo
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Note: Using the `solo` pool is recommended for development but not for production.
|
|
159
|
+
|
|
160
|
+
## Updating translations
|
|
161
|
+
|
|
162
|
+
**Docker:**
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
make translations
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
**Native:**
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
python manage.py makemessages --all --ignore node_modules --ignore .venv
|
|
172
|
+
python manage.py makemessages -d djangojs --all --ignore node_modules --ignore .venv
|
|
173
|
+
python manage.py compilemessages --ignore .venv
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Google Authentication Setup
|
|
177
|
+
|
|
178
|
+
To setup Google Authentication, follow the [instructions here](https://docs.allauth.org/en/latest/socialaccount/providers/google.html).
|
|
179
|
+
|
|
180
|
+
## Installing Git commit hooks
|
|
181
|
+
|
|
182
|
+
To install the Git commit hooks run the following:
|
|
183
|
+
|
|
184
|
+
```shell
|
|
185
|
+
$ pre-commit install --install-hooks
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Once these are installed they will be run on every commit.
|
|
189
|
+
|
|
190
|
+
For more information see the [docs](https://docs.saaspegasus.com/code-structure.html#code-formatting).
|
|
191
|
+
|
|
192
|
+
## Running Tests
|
|
193
|
+
|
|
194
|
+
To run tests:
|
|
195
|
+
|
|
196
|
+
**Docker:**
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
make test
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
**Native:**
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
python manage.py test
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
Or to test a specific app/module:
|
|
209
|
+
|
|
210
|
+
**Docker:**
|
|
211
|
+
|
|
212
|
+
```bash
|
|
213
|
+
make test ARGS='apps.utils.tests.test_slugs --keepdb'
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
**Native:**
|
|
217
|
+
|
|
218
|
+
```bash
|
|
219
|
+
python manage.py test apps.utils.tests.test_slugs
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
On Linux-based systems you can watch for changes using the following:
|
|
223
|
+
|
|
224
|
+
**Docker:**
|
|
225
|
+
|
|
226
|
+
```bash
|
|
227
|
+
find . -name '*.py' | entr docker compose exec web python manage.py test apps.utils.tests.test_slugs
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
**Native:**
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
find . -name '*.py' | entr python manage.py test apps.utils.tests.test_slugs
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## Project-specific Setup
|
|
237
|
+
|
|
238
|
+
1. Bootstrap Skill model objects
|
|
239
|
+
|
|
240
|
+
```bash
|
|
241
|
+
make manage ARGS='bootstrap_skills'
|
|
242
|
+
```
|
|
243
|
+
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "talentprism-cli"
|
|
7
|
+
version = "0.3.0"
|
|
8
|
+
description = "Command line for TalentPrism: team-scoped recruiting data and actions for people and AI agents"
|
|
9
|
+
readme = "talentprism_cli/README.md"
|
|
10
|
+
license = "LicenseRef-Proprietary"
|
|
11
|
+
# Only the CLI licence ships; the repo-root LICENSE.md is the SaaS Pegasus licence for the web app.
|
|
12
|
+
license-files = ["talentprism_cli/LICENSE.txt"]
|
|
13
|
+
requires-python = ">=3.11"
|
|
14
|
+
keywords = ["talentprism", "recruiting", "cli", "agents"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Environment :: Console",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"Operating System :: OS Independent",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Programming Language :: Python :: 3.11",
|
|
21
|
+
"Programming Language :: Python :: 3.12",
|
|
22
|
+
"Programming Language :: Python :: 3.13",
|
|
23
|
+
"Topic :: Office/Business",
|
|
24
|
+
]
|
|
25
|
+
dependencies = [
|
|
26
|
+
"PyYAML>=6.0.0",
|
|
27
|
+
"requests>=2.32.0",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
[project.urls]
|
|
31
|
+
Homepage = "https://talentprism.ai"
|
|
32
|
+
Documentation = "https://talentprism.ai/help/talentprism-cli/"
|
|
33
|
+
|
|
34
|
+
[project.scripts]
|
|
35
|
+
tp = "talentprism_cli.__main__:main"
|
|
36
|
+
|
|
37
|
+
[tool.setuptools.packages.find]
|
|
38
|
+
include = ["talentprism_cli*"]
|
|
39
|
+
exclude = ["talentprism_cli.tests*"]
|
|
40
|
+
|
|
41
|
+
[tool.ruff]
|
|
42
|
+
# Exclude a variety of commonly ignored directories.
|
|
43
|
+
exclude = [
|
|
44
|
+
".direnv",
|
|
45
|
+
".git",
|
|
46
|
+
".ruff_cache",
|
|
47
|
+
"node_modules",
|
|
48
|
+
"migrations",
|
|
49
|
+
]
|
|
50
|
+
line-length = 120
|
|
51
|
+
indent-width = 4
|
|
52
|
+
target-version = "py311"
|
|
53
|
+
|
|
54
|
+
[tool.ruff.lint]
|
|
55
|
+
fixable = [
|
|
56
|
+
"ALL",
|
|
57
|
+
]
|
|
58
|
+
unfixable = []
|
|
59
|
+
|
|
60
|
+
# Ignore rules that have too many pre-existing violations
|
|
61
|
+
ignore = [
|
|
62
|
+
"F403", # wildcard imports (used in views/__init__.py patterns)
|
|
63
|
+
"F821", # undefined names (false positives from star imports & dynamic code)
|
|
64
|
+
"E402", # module-level import not at top (Django patterns)
|
|
65
|
+
"E722", # bare except
|
|
66
|
+
"F811", # redefined unused name
|
|
67
|
+
]
|
|
68
|
+
|
|
69
|
+
[tool.ruff.format]
|
|
70
|
+
quote-style = "double"
|
|
71
|
+
indent-style = "space"
|
|
72
|
+
skip-magic-trailing-comma = false
|
|
73
|
+
line-ending = "auto"
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
TalentPrism CLI License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 TalentPrism. All rights reserved.
|
|
4
|
+
|
|
5
|
+
This software is provided for use with a TalentPrism account, under the
|
|
6
|
+
TalentPrism terms of service. You may install and run it on systems you
|
|
7
|
+
control to access TalentPrism services that you are authorized to use.
|
|
8
|
+
|
|
9
|
+
You may not modify, copy, redistribute, sublicense or sell this software,
|
|
10
|
+
or use it to access TalentPrism other than through your own authorized
|
|
11
|
+
account, without prior written permission from TalentPrism.
|
|
12
|
+
|
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
16
|
+
TALENTPRISM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY ARISING
|
|
17
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR ITS USE.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# TalentPrism CLI
|
|
2
|
+
|
|
3
|
+
`tp` is the command line for TalentPrism. It reads team-scoped recruiting data (sequences, candidates, interviews, reminders, campaign and activity summaries, evidence records) and makes changes through the same permissions and validation as the web app. It prints JSON that scripts and AI agents can parse, and reports errors as structured JSON with a stable `code`.
|
|
4
|
+
|
|
5
|
+
Full documentation: https://talentprism.ai/help/talentprism-cli/
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```shell
|
|
10
|
+
pipx install talentprism-cli
|
|
11
|
+
# or
|
|
12
|
+
uv tool install talentprism-cli
|
|
13
|
+
|
|
14
|
+
tp --version
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Requires Python 3.11 or newer.
|
|
18
|
+
|
|
19
|
+
## Sign in
|
|
20
|
+
|
|
21
|
+
People sign in with the browser:
|
|
22
|
+
|
|
23
|
+
```shell
|
|
24
|
+
tp login
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Pick a team and approve. The CLI keeps short-lived tokens in `~/.talentprism/config.toml` and refreshes them on its own. Use `tp login --no-browser` over SSH, and `tp logout` to sign out.
|
|
28
|
+
|
|
29
|
+
Scripts, CI jobs and AI agents use a team-scoped API key instead:
|
|
30
|
+
|
|
31
|
+
```shell
|
|
32
|
+
export TALENTPRISM_API_KEY="<your api key>"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
New API keys expire one year after they are created. Your account page shows each key's expiry date and when it was last used; create a replacement key before the old one expires.
|
|
36
|
+
|
|
37
|
+
When several credentials are present, `tp` uses the first of: the `--api-key` flag, `TALENTPRISM_API_KEY`, login tokens in the profile, `api_key` in the profile. The server is `https://talentprism.ai` unless you set `TALENTPRISM_BASE_URL` (local development only).
|
|
38
|
+
|
|
39
|
+
## Examples
|
|
40
|
+
|
|
41
|
+
```shell
|
|
42
|
+
tp whoami
|
|
43
|
+
tp sequences list --status Active --json
|
|
44
|
+
tp candidates search --query "aircraft assembler North Charleston" --json
|
|
45
|
+
tp activity summary --days 14 --json
|
|
46
|
+
tp candidates timeline <candidate_id> --days 30 --json
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Changing data
|
|
50
|
+
|
|
51
|
+
Every write is two steps. Run the command once to get a preview and a one-time approval token. Nothing changes. Then run the same command again with `--confirm-write --approval-token <token>`:
|
|
52
|
+
|
|
53
|
+
```shell
|
|
54
|
+
tp candidates add-note 123 --text "Prefers second shift"
|
|
55
|
+
tp candidates add-note 123 --text "Prefers second shift" --confirm-write --approval-token <token>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Rate limits
|
|
59
|
+
|
|
60
|
+
Per credential (each API key, or each login), per minute: 300 reads, 60 changes, and 30 copilot questions (`tp copilot ask` and `tp copilot brief`). Previews count as reads. When a limit is hit the CLI reports `rate_limited` with a `retry_after` value.
|
|
61
|
+
|
|
62
|
+
## Help
|
|
63
|
+
|
|
64
|
+
- `tp --help` and `tp <command> --help` list every command and flag.
|
|
65
|
+
- `tp skill print` prints the agent skill text bundled with the CLI.
|
|
66
|
+
- Errors come with a `remediation` line. The help page has a troubleshooting table keyed by error code.
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
Proprietary. The CLI is provided for use with a TalentPrism account; see `LICENSE.txt` in the package.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.3.0"
|