@maximoai/maximo-syntax-cli 0.1.14 → 0.1.16
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 +56 -8
- package/dist/cli.mjs +6478 -5354
- package/package.json +3 -4
package/README.md
CHANGED
|
@@ -54,12 +54,60 @@ After installation, you can invoke the CLI using any of the following commands:
|
|
|
54
54
|
- `maximo`
|
|
55
55
|
- `maximo-syntax`
|
|
56
56
|
- `maximo-syntax-cli`
|
|
57
|
-
- `
|
|
57
|
+
- `maximo`
|
|
58
58
|
|
|
59
59
|
All five commands are equivalent and natively supported.
|
|
60
60
|
|
|
61
61
|
---
|
|
62
62
|
|
|
63
|
+
## Login
|
|
64
|
+
|
|
65
|
+
Maximo Syntax CLI supports several ways to sign in. Run the login flow and pick the option that matches your setup:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
maximo login
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
| Option | What it is | Notes |
|
|
72
|
+
|--------|------------|-------|
|
|
73
|
+
| **Maximo AI account** | First-party Maximo AI subscription/pro API key | Default provider; routes through `https://api.maximoai.co/v1`. |
|
|
74
|
+
| **MyTabulon Coding Plan** | MyTabulon platform API key (`mtb_live_…`) | Sign in via browser OAuth or paste a `mtb_live_` key. |
|
|
75
|
+
| **Cencori** | Cencori OpenAI-compatible API key (`csk_…`) | Cencori is OpenAI-compatible, so chat and models go through `https://api.cencori.com/v1`. Paste your `csk_` key at the prompt — the key is saved to your global config and used for all API calls. |
|
|
76
|
+
| **3rd-party platform** | OpenAI, Gemini, Bedrock, Ollama, and more | Set the relevant environment variables and restart. See [Alternative Providers](#alternative-providers). |
|
|
77
|
+
|
|
78
|
+
To switch providers (e.g. to Cencori) at any time, run `maximo login` again and choose the provider you want.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Keeping Maximo Syntax up to date
|
|
83
|
+
|
|
84
|
+
Maximo Syntax installs via npm, so updating is just reinstalling the latest published version:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npm install -g @maximoai/maximo-syntax-cli
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
You can also update right from inside the CLI:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
/update
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
`/update` runs `npm install -g @maximoai/maximo-syntax-cli` (always pulls the `latest` dist-tag) and tells you to restart the CLI once it finishes. Native and OS-package-manager installs are left to their own update channels.
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## Images: paste and drag-and-drop
|
|
101
|
+
|
|
102
|
+
You can attach images to a prompt by **copy-paste** or by **dragging and dropping** a file into the terminal — both work the same way:
|
|
103
|
+
|
|
104
|
+
- Pasted images are read from the clipboard and attached inline.
|
|
105
|
+
- Dragged images are resolved from the dropped file path (including basename-only drops from common folders like `~/Documents`, `~/Desktop`, `~/Pictures`, and iCloud Drive).
|
|
106
|
+
|
|
107
|
+
In both cases the image is previewed with a `[Image #N]` reference before you send, and the original bytes are preserved (no silent resize or recompress). Up to 10 images can be attached per prompt.
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
63
111
|
## Quick Start
|
|
64
112
|
|
|
65
113
|
### 1. Set up Maximo AI (Recommended)
|
|
@@ -67,7 +115,7 @@ All five commands are equivalent and natively supported.
|
|
|
67
115
|
Maximo Syntax CLI uses Maximo AI as the default provider. Get your API key from [Maximo AI](https://maximoai.co/platform) and set the following environment variables:
|
|
68
116
|
|
|
69
117
|
```bash
|
|
70
|
-
export
|
|
118
|
+
export MAXIMO_SYNTAX_USE_OPENAI=1
|
|
71
119
|
export OPENAI_API_KEY=your-maximo-api-key
|
|
72
120
|
export OPENAI_BASE_URL=https://api.maximoai.co/v1
|
|
73
121
|
export OPENAI_MODEL=maximo-pandora-3.7-nano
|
|
@@ -76,7 +124,7 @@ export OPENAI_MODEL=maximo-pandora-3.7-nano
|
|
|
76
124
|
Or create a `.env` file in your project directory:
|
|
77
125
|
|
|
78
126
|
```
|
|
79
|
-
|
|
127
|
+
MAXIMO_SYNTAX_USE_OPENAI=1
|
|
80
128
|
OPENAI_API_KEY=your-maximo-api-key
|
|
81
129
|
OPENAI_BASE_URL=https://api.maximoai.co/v1
|
|
82
130
|
OPENAI_MODEL=maximo-pandora-3.7-nano
|
|
@@ -95,7 +143,7 @@ maximo
|
|
|
95
143
|
### OpenAI / Any OpenAI-compatible provider (GPT-4o, DeepSeek, Ollama, Groq)
|
|
96
144
|
|
|
97
145
|
```bash
|
|
98
|
-
export
|
|
146
|
+
export MAXIMO_SYNTAX_USE_OPENAI=1
|
|
99
147
|
export OPENAI_API_KEY=sk-...
|
|
100
148
|
export OPENAI_MODEL=gpt-4o
|
|
101
149
|
```
|
|
@@ -103,21 +151,21 @@ export OPENAI_MODEL=gpt-4o
|
|
|
103
151
|
### Google Gemini (free key at https://aistudio.google.com/apikey)
|
|
104
152
|
|
|
105
153
|
```bash
|
|
106
|
-
export
|
|
154
|
+
export MAXIMO_SYNTAX_USE_GEMINI=1
|
|
107
155
|
export GEMINI_API_KEY=your-key
|
|
108
156
|
```
|
|
109
157
|
|
|
110
158
|
### Amazon Bedrock
|
|
111
159
|
|
|
112
|
-
See documentation: https://code.
|
|
160
|
+
See documentation: https://code.maximo.com/docs/en/amazon-bedrock
|
|
113
161
|
|
|
114
162
|
### Microsoft Foundry
|
|
115
163
|
|
|
116
|
-
See documentation: https://code.
|
|
164
|
+
See documentation: https://code.maximo.com/docs/en/microsoft-foundry
|
|
117
165
|
|
|
118
166
|
### Vertex AI
|
|
119
167
|
|
|
120
|
-
See documentation: https://code.
|
|
168
|
+
See documentation: https://code.maximo.com/docs/en/google-vertex-ai
|
|
121
169
|
|
|
122
170
|
|
|
123
171
|
---
|