@reminix/cli 0.1.8 → 0.1.9
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 +47 -87
- package/dist/commands/version.d.ts +1 -1
- package/dist/commands/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @reminix/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Official CLI for [Reminix](https://reminix.com) — deploy and manage AI agents from the command line.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -8,121 +8,81 @@ Reminix CLI - Command-line interface for Reminix.
|
|
|
8
8
|
npm install -g @reminix/cli
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Or with other package managers:
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
reminix
|
|
15
|
-
reminix
|
|
14
|
+
pnpm add -g @reminix/cli
|
|
15
|
+
yarn global add @reminix/cli
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
##
|
|
19
|
-
|
|
20
|
-
### Prerequisites
|
|
21
|
-
|
|
22
|
-
- Node.js 20+
|
|
23
|
-
- [pnpm](https://pnpm.io/) (recommended)
|
|
24
|
-
|
|
25
|
-
### Setup
|
|
18
|
+
## Quick Start
|
|
26
19
|
|
|
27
20
|
```bash
|
|
28
|
-
#
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
# Install dependencies
|
|
32
|
-
pnpm install
|
|
33
|
-
|
|
34
|
-
# Build the CLI package
|
|
35
|
-
pnpm cli:build
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Testing Locally
|
|
21
|
+
# Login to your Reminix account
|
|
22
|
+
reminix login
|
|
39
23
|
|
|
40
|
-
|
|
24
|
+
# Set your default project (so you don't need -p every time)
|
|
25
|
+
reminix config set project <org-slug>/<project-slug>
|
|
41
26
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
pnpm cli --version
|
|
45
|
-
pnpm cli --help
|
|
27
|
+
# List your projects
|
|
28
|
+
reminix projects list
|
|
46
29
|
|
|
47
|
-
#
|
|
48
|
-
|
|
49
|
-
pnpm cli:run --version
|
|
30
|
+
# Invoke an agent
|
|
31
|
+
reminix agents invoke my-agent -i '{"prompt": "Hello!"}'
|
|
50
32
|
|
|
51
|
-
#
|
|
52
|
-
|
|
53
|
-
reminix --version
|
|
54
|
-
|
|
55
|
-
# Unlink when done
|
|
56
|
-
pnpm cli:unlink
|
|
33
|
+
# Chat with an agent
|
|
34
|
+
reminix agents chat my-agent -m "Hello!"
|
|
57
35
|
```
|
|
58
36
|
|
|
59
|
-
|
|
37
|
+
## Commands
|
|
60
38
|
|
|
61
|
-
|
|
62
|
-
|
|
39
|
+
| Command | Description |
|
|
40
|
+
|---------|-------------|
|
|
41
|
+
| `reminix login` | Authenticate with Reminix |
|
|
42
|
+
| `reminix logout` | Clear authentication |
|
|
43
|
+
| `reminix whoami` | Show current user |
|
|
44
|
+
| `reminix projects list` | List all projects |
|
|
45
|
+
| `reminix projects current` | Get current project details |
|
|
46
|
+
| `reminix agents invoke <name>` | Invoke an agent with input |
|
|
47
|
+
| `reminix agents chat <name>` | Chat with an agent |
|
|
48
|
+
| `reminix config set <key> <value>` | Set configuration value |
|
|
49
|
+
| `reminix config get <key>` | Get configuration value |
|
|
50
|
+
| `reminix config list` | List all configuration |
|
|
63
51
|
|
|
64
|
-
|
|
65
|
-
pnpm dev --version
|
|
52
|
+
## Configuration
|
|
66
53
|
|
|
67
|
-
|
|
68
|
-
pnpm build
|
|
69
|
-
node dist/index.js --version
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### Writing Tests
|
|
73
|
-
|
|
74
|
-
Tests are located in `tests/` and use [Vitest](https://vitest.dev/).
|
|
75
|
-
|
|
76
|
-
#### Test Structure
|
|
77
|
-
|
|
78
|
-
Create test files with the pattern `*.test.ts` in the `tests/` directory:
|
|
54
|
+
### Default Project
|
|
79
55
|
|
|
80
|
-
|
|
81
|
-
import { describe, it, expect } from 'vitest';
|
|
82
|
-
import { version } from '../src/commands/version.js';
|
|
56
|
+
Set a default project to avoid passing `-p` on every command:
|
|
83
57
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
expect(typeof version).toBe('string');
|
|
87
|
-
expect(version).toBeTruthy();
|
|
88
|
-
});
|
|
89
|
-
});
|
|
58
|
+
```bash
|
|
59
|
+
reminix config set project acme/my-app
|
|
90
60
|
```
|
|
91
61
|
|
|
92
|
-
|
|
62
|
+
### Environment Variables
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
| Variable | Description |
|
|
65
|
+
|----------|-------------|
|
|
66
|
+
| `REMINIX_PROJECT` | Default project (overrides config file) |
|
|
67
|
+
| `REMINIX_API_URL` | API URL (for self-hosted instances) |
|
|
95
68
|
|
|
96
|
-
|
|
97
|
-
import { describe, it, expect } from 'vitest';
|
|
98
|
-
import { execSync } from 'child_process';
|
|
69
|
+
Priority: CLI flag (`-p`) → Environment variable → Config file
|
|
99
70
|
|
|
100
|
-
|
|
101
|
-
it('should show version', () => {
|
|
102
|
-
const output = execSync('node dist/index.js --version', { encoding: 'utf-8' });
|
|
103
|
-
expect(output.trim()).toContain('0.1.0');
|
|
104
|
-
});
|
|
105
|
-
});
|
|
106
|
-
```
|
|
71
|
+
## Output Formats
|
|
107
72
|
|
|
108
|
-
|
|
73
|
+
Most commands support `-o, --output` for different output formats:
|
|
109
74
|
|
|
110
75
|
```bash
|
|
111
|
-
#
|
|
112
|
-
|
|
113
|
-
pnpm test
|
|
76
|
+
# Human-readable table (default)
|
|
77
|
+
reminix projects list
|
|
114
78
|
|
|
115
|
-
#
|
|
116
|
-
|
|
79
|
+
# JSON (for scripting)
|
|
80
|
+
reminix projects list -o json
|
|
117
81
|
```
|
|
118
82
|
|
|
119
|
-
|
|
83
|
+
## Documentation
|
|
120
84
|
|
|
121
|
-
|
|
122
|
-
# From package directory
|
|
123
|
-
cd packages/cli
|
|
124
|
-
pnpm build
|
|
125
|
-
```
|
|
85
|
+
Full documentation: [reminix.com/docs](https://reminix.com/docs)
|
|
126
86
|
|
|
127
87
|
## License
|
|
128
88
|
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const version = "0.1.
|
|
1
|
+
export declare const version = "0.1.9";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/commands/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const version = '0.1.
|
|
1
|
+
export const version = '0.1.9';
|
|
2
2
|
//# sourceMappingURL=version.js.map
|