@ibm/ixora 0.1.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.
- package/README.md +85 -0
- package/dist/index.js +1779 -0
- package/package.json +50 -0
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# ixora
|
|
2
|
+
|
|
3
|
+
CLI for managing ixora AI agent deployments on IBM i.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g @ibm/ixora
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or run directly with npx:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npx @ibm/ixora install
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Requirements
|
|
18
|
+
|
|
19
|
+
- Node.js >= 18
|
|
20
|
+
- Docker Desktop (or Podman)
|
|
21
|
+
- An IBM i system with Db2 for i
|
|
22
|
+
- An API key for your chosen model provider (Anthropic, OpenAI, Google, or Ollama for local)
|
|
23
|
+
|
|
24
|
+
## Quick Start
|
|
25
|
+
|
|
26
|
+
```sh
|
|
27
|
+
ixora install # Interactive setup (IBM i connection, model provider, profile)
|
|
28
|
+
ixora start # Start services
|
|
29
|
+
ixora stop # Stop services
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Commands
|
|
33
|
+
|
|
34
|
+
| Command | Description |
|
|
35
|
+
|---------|-------------|
|
|
36
|
+
| `install` | First-time setup (interactive) |
|
|
37
|
+
| `start` | Start services |
|
|
38
|
+
| `stop` | Stop services |
|
|
39
|
+
| `restart [service]` | Restart all or a specific service |
|
|
40
|
+
| `status` | Show service status and deployed profile |
|
|
41
|
+
| `upgrade` | Pull latest images and restart |
|
|
42
|
+
| `uninstall` | Stop services and remove images |
|
|
43
|
+
| `logs [service]` | Tail service logs |
|
|
44
|
+
| `version` | Show CLI and image versions |
|
|
45
|
+
| `config show` | Show current configuration |
|
|
46
|
+
| `config set <key> <value>` | Update a config value |
|
|
47
|
+
| `config edit` | Open config in your editor |
|
|
48
|
+
| `system add` | Add an IBM i system |
|
|
49
|
+
| `system remove` | Remove a system |
|
|
50
|
+
| `system list` | List configured systems |
|
|
51
|
+
|
|
52
|
+
## Options
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
--profile <name> Agent profile (full|sql-services|security|knowledge)
|
|
56
|
+
--image-version <tag> Pin image version (e.g., v1.2.0)
|
|
57
|
+
--no-pull Skip pulling images
|
|
58
|
+
--purge Remove volumes too (with uninstall)
|
|
59
|
+
--runtime <name> Force docker or podman
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Development
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
git clone https://github.com/ibmi-agi/ixora-cli.git
|
|
66
|
+
cd ixora-cli
|
|
67
|
+
npm install
|
|
68
|
+
npm run build
|
|
69
|
+
npm link # Makes 'ixora' available globally
|
|
70
|
+
|
|
71
|
+
npm test # Run tests
|
|
72
|
+
npm run dev -- <command> # Run without building
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Legacy: Shell Script Version
|
|
78
|
+
|
|
79
|
+
The original `ixora.sh` shell script is still available in this repo for reference. To install it directly:
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
curl -LsSf https://raw.githubusercontent.com/ibmi-agi/ixora-cli/main/install.sh | sh
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
This installs the shell script to `~/.local/bin/ixora`. The Node.js CLI above is the recommended version going forward.
|