@deepraxis/cli 0.1.0-dev.e4c5523 → 0.1.0-dev.ea77ce8
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/COMMANDS.md +370 -0
- package/LICENSE +202 -67
- package/README.md +200 -36
- package/dist/praxis.js +145 -42
- package/package.json +22 -13
package/LICENSE
CHANGED
|
@@ -1,67 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
the
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
or
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,56 +1,220 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
Praxis
|
|
3
|
+
# Praxis CLI
|
|
4
|
+
|
|
5
|
+
**Models, agents, sandboxes, search and data from one terminal, with one account.**
|
|
6
|
+
|
|
7
|
+
The official command line for [知行云 Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@deepraxis/cli)
|
|
10
|
+
[](https://nodejs.org)
|
|
11
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
12
|
+
|
|
13
|
+
[Website](https://deepraxis.com) · [Documentation](https://docs.deepraxis.com) · [API reference](https://docs.deepraxis.com/docs/api) · [Console](https://console.deepraxis.com)
|
|
14
|
+
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
---
|
|
4
18
|
|
|
5
19
|
```sh
|
|
6
|
-
npm
|
|
7
|
-
praxis --help
|
|
20
|
+
npm install -g @deepraxis/cli
|
|
8
21
|
praxis login
|
|
22
|
+
praxis model chat completion create --model deepseek-flash \
|
|
23
|
+
--data '{"messages":[{"role":"user","content":"Hello!"}]}'
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Every operation of the Praxis API is a command: about 350 of them across models, agents,
|
|
27
|
+
sandboxes, cloud browsers, web search, databases, knowledge bases, files, media, automation
|
|
28
|
+
and hosted applications. The command tree is generated from the same contract as the API and
|
|
29
|
+
the SDK, so a new API capability reaches the CLI on the day it ships.
|
|
30
|
+
|
|
31
|
+
## Why Praxis CLI
|
|
32
|
+
|
|
33
|
+
- **One account, every capability.** Chat with models from many providers, start a sandbox,
|
|
34
|
+
search the web and query a database without juggling vendor keys.
|
|
35
|
+
- **Made for people and for AI agents.** Readable tables in your terminal, compact text when an
|
|
36
|
+
AI coding agent runs it, and clean JSON in scripts. The CLI picks the mode by itself.
|
|
37
|
+
- **Signs in through the browser.** `praxis login` approves the session in your browser and
|
|
38
|
+
keeps the credential in the system keychain, never in a dotfile when a keychain exists.
|
|
39
|
+
- **Predictable grammar.** `praxis <domain> <resource> <verb> [id]`, the same shape everywhere,
|
|
40
|
+
with `--help` on every level.
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
Requires [Node.js](https://nodejs.org) 20 or newer.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
npm install -g @deepraxis/cli # or: pnpm add -g / bun add -g
|
|
48
|
+
praxis --version
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Run it once without installing:
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
npx @deepraxis/cli model list
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Sign in
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
praxis login # approve in the browser with the code shown
|
|
61
|
+
praxis whoami # account, organization, credential storage
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
You need a Praxis account; sign up at [deepraxis.com](https://deepraxis.com).
|
|
65
|
+
|
|
66
|
+
Belong to several organizations? Every call runs in the active one:
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
praxis org list
|
|
70
|
+
praxis org switch <organization_id>
|
|
71
|
+
praxis model list --org <organization_id> # just this call
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
For CI and other headless environments, create an API key in the
|
|
75
|
+
[Console](https://console.deepraxis.com/keys) and set it instead of logging in.
|
|
76
|
+
`PRAXIS_API_KEY` always takes precedence over a stored login:
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
export PRAXIS_API_KEY=<your-api-key>
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## A tour
|
|
83
|
+
|
|
84
|
+
### Models
|
|
85
|
+
|
|
86
|
+
```sh
|
|
9
87
|
praxis model list
|
|
88
|
+
praxis model chat completion create --model deepseek-flash \
|
|
89
|
+
--data '{"messages":[{"role":"user","content":"A haiku"}]}'
|
|
90
|
+
praxis model embedding create --model <embedding_model> \
|
|
91
|
+
--data '{"input":"hello world"}'
|
|
92
|
+
praxis model image generation create --model <image_model> \
|
|
93
|
+
--prompt "a lighthouse at dawn"
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Agents
|
|
97
|
+
|
|
98
|
+
Define an agent once, then talk to it in sessions:
|
|
99
|
+
|
|
100
|
+
```sh
|
|
101
|
+
praxis agent create --data '{
|
|
102
|
+
"name": "helper",
|
|
103
|
+
"model": {"id": "deepseek-flash"},
|
|
104
|
+
"tools": [{"type": "agent_toolset_20260401"}]
|
|
105
|
+
}'
|
|
106
|
+
praxis agent session create --data '{"agent": "<agent_id>"}'
|
|
107
|
+
praxis agent session event send <session_id> --data '{
|
|
108
|
+
"events": [{
|
|
109
|
+
"type": "user.message",
|
|
110
|
+
"content": [{"type": "text", "text": "What can you do?"}]
|
|
111
|
+
}]
|
|
112
|
+
}'
|
|
113
|
+
praxis agent session event stream --session <session_id>
|
|
10
114
|
```
|
|
11
115
|
|
|
12
|
-
|
|
13
|
-
select an environment; the stable package defaults to production. For scripts,
|
|
14
|
-
set `PRAXIS_API_KEY` in the environment instead of using `praxis login`.
|
|
116
|
+
### Sandboxes
|
|
15
117
|
|
|
16
|
-
|
|
118
|
+
```sh
|
|
119
|
+
praxis sandbox create --template-id base
|
|
120
|
+
praxis sandbox command run <sandbox_id> \
|
|
121
|
+
--cmd "python3 -c 'print(6 * 7)'"
|
|
122
|
+
praxis sandbox delete <sandbox_id> --yes
|
|
123
|
+
```
|
|
17
124
|
|
|
18
|
-
|
|
19
|
-
- `--format agent`: compact text for agents.
|
|
20
|
-
- `--json` (or `--format json`): JSON for scripts.
|
|
125
|
+
### Search, data and automation
|
|
21
126
|
|
|
22
127
|
```sh
|
|
23
|
-
praxis
|
|
24
|
-
praxis
|
|
25
|
-
praxis
|
|
128
|
+
praxis search create --query "AI agent frameworks" --max-results 5
|
|
129
|
+
praxis database create --name notes
|
|
130
|
+
praxis automation run create --data '{
|
|
131
|
+
"source": "export default async (i) => ({ answer: i.n + 1 })",
|
|
132
|
+
"language": "ts", "input": {"n": 41}, "wait": 30
|
|
133
|
+
}'
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
Browse everything with `praxis --help`, `praxis <domain> --help`, or the full
|
|
137
|
+
[command reference](https://unpkg.com/@deepraxis/cli/COMMANDS.md) that ships in the package.
|
|
138
|
+
|
|
139
|
+
## How commands work
|
|
140
|
+
|
|
141
|
+
```text
|
|
142
|
+
praxis sandbox command run sbx_123 --cmd "ls" --json
|
|
143
|
+
domain resource verb target options global
|
|
26
144
|
```
|
|
27
145
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
`--
|
|
32
|
-
|
|
33
|
-
|
|
146
|
+
- **One target, positionally.** The object a command acts on comes right after the verb. Parent
|
|
147
|
+
objects are options: `praxis database table list --database <database_id>`.
|
|
148
|
+
- **Request bodies.** Simple fields have their own options. Anything else goes in `--data`, as
|
|
149
|
+
inline JSON, a file (`--data @body.json`) or stdin (`--data -`). Field options win over the
|
|
150
|
+
same field in `--data`.
|
|
151
|
+
- **Lists.** `--limit 10` shows the first ten items, `--all` follows every page, and `--cursor`
|
|
152
|
+
resumes from a page you saved.
|
|
153
|
+
- **Safety.** Deleting and other destructive commands ask for confirmation, or need `--yes`
|
|
154
|
+
when no one can answer, for example in a script.
|
|
155
|
+
- **Escape hatch.** `praxis api <METHOD> <path> [--data …]` calls any endpoint with your
|
|
156
|
+
current credential, including ones that are new since your installed version.
|
|
34
157
|
|
|
35
|
-
|
|
158
|
+
## Output for people, AI agents and scripts
|
|
159
|
+
|
|
160
|
+
| You run it… | You get | Choose it explicitly |
|
|
161
|
+
|---|---|---|
|
|
162
|
+
| in a terminal | aligned tables, colors, readable details and next-step hints | `--format human` |
|
|
163
|
+
| inside an AI coding agent (Claude Code, Codex, Cursor, Gemini CLI…) | compact, token-light text with exact follow-up commands | `--format agent` |
|
|
164
|
+
| in a pipe or a script | the API response as JSON, nothing else on stdout | `--json` |
|
|
165
|
+
|
|
166
|
+
Errors follow the same rule. In JSON they are one object on stderr with `code`, `message`,
|
|
167
|
+
`hint`, `status` and `request_id`, so a script or an agent can tell a typo from a quota limit.
|
|
168
|
+
|
|
169
|
+
```sh
|
|
170
|
+
praxis model list --json | jq -r '.data[].id'
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Teach your AI agent to use Praxis
|
|
174
|
+
|
|
175
|
+
The CLI writes its own skill file: the general rules plus one line per command, generated from
|
|
176
|
+
the API contract.
|
|
36
177
|
|
|
37
178
|
```sh
|
|
38
|
-
praxis skill
|
|
39
|
-
praxis skill
|
|
179
|
+
praxis skill --install ~/.claude/skills # praxis-cli/SKILL.md
|
|
180
|
+
praxis skill > SKILL.md # or print it
|
|
40
181
|
```
|
|
41
182
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
183
|
+
After that, an agent such as Claude Code can drive every Praxis capability through the CLI and
|
|
184
|
+
read results in its compact agent format.
|
|
185
|
+
|
|
186
|
+
## Environment variables
|
|
187
|
+
|
|
188
|
+
| Variable | Purpose |
|
|
189
|
+
|---|---|
|
|
190
|
+
| `PRAXIS_API_KEY` | Authenticate with an API key instead of `praxis login`. |
|
|
191
|
+
| `PRAXIS_ENV` | `production` (default) or `develop`, for Praxis team members testing pre-release services. |
|
|
192
|
+
| `PRAXIS_CREDENTIAL_STORE` | Set to `file` to keep logins out of the system keychain, for example in disposable test homes. |
|
|
193
|
+
| `NO_COLOR` | Disable colors in human output. |
|
|
194
|
+
|
|
195
|
+
Credentials live in the macOS Keychain, or in the Secret Service through `secret-tool` on
|
|
196
|
+
Linux. Without a keychain they are written to `~/.praxis/cli/<env>.json` with mode 0600, and
|
|
197
|
+
`praxis whoami` tells you which one is in use. `praxis logout` removes both.
|
|
198
|
+
|
|
199
|
+
## Release channels
|
|
200
|
+
|
|
201
|
+
| Channel | Install | What it is |
|
|
202
|
+
|---|---|---|
|
|
203
|
+
| `latest` | `npm i -g @deepraxis/cli` | Stable releases. |
|
|
204
|
+
| `dev` | `npm i -g @deepraxis/cli@dev` | A build of every change as it lands, pointed at the Praxis develop environment. For the Praxis team and early testers. |
|
|
205
|
+
|
|
206
|
+
## Resources
|
|
207
|
+
|
|
208
|
+
- [Documentation](https://docs.deepraxis.com) and [API reference](https://docs.deepraxis.com/docs/api)
|
|
209
|
+
- [Command reference](https://unpkg.com/@deepraxis/cli/COMMANDS.md)
|
|
210
|
+
- TypeScript SDK: [`@deepraxis/sdk`](https://www.npmjs.com/package/@deepraxis/sdk), the same API as code
|
|
211
|
+
- Already using the OpenAI or Anthropic SDK? Point its `baseURL` at
|
|
212
|
+
`https://api.deepraxis.com/openai/v1` or the Anthropic-compatible endpoint, as the
|
|
213
|
+
[SDK cookbook](https://docs.deepraxis.com/docs/cookbook/sdk) shows.
|
|
214
|
+
|
|
215
|
+
## License
|
|
45
216
|
|
|
46
|
-
|
|
47
|
-
`secret-tool`. If the system keychain is unavailable, login reports file storage
|
|
48
|
-
at `~/.praxis/cli/<env>.json` (mode 0600). Existing files migrate automatically
|
|
49
|
-
when keychain storage succeeds. `praxis whoami` shows the storage location;
|
|
50
|
-
`praxis logout` removes both copies. On macOS, writes use `security -i` with
|
|
51
|
-
the secret on stdin, never in process arguments. Records exceeding the tool's
|
|
52
|
-
4096-byte interactive command limit also use the file fallback.
|
|
217
|
+
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). Copyright 2026 南京深度实践人工智能科技有限公司 (Deepractice).
|
|
53
218
|
|
|
54
|
-
|
|
55
|
-
to
|
|
56
|
-
checks both. OpenAPI sync regenerates these documents after the SDK manifest.
|
|
219
|
+
"Praxis", "知行云" and "Deepraxis" are trademarks of Deepractice; the license does not grant
|
|
220
|
+
rights to use them.
|