@infersec/conduit 1.95.0 → 1.97.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 CHANGED
@@ -10,10 +10,10 @@ npx @infersec/conduit inference start --engine <type> --key <api-key> --source <
10
10
 
11
11
  ### Commands
12
12
 
13
- | Command | Description |
14
- | ----------------------- | --------------------------------------------------------- |
15
- | `inference start` | Start the inference agent |
16
- | `tool connect <toolID>` | Connect a local tool (e.g. `local-filesystem`) to the API |
13
+ | Command | Description |
14
+ | ----------------------- | ------------------------------------------------------------------------------------------------------ |
15
+ | `inference start` | Start the inference agent |
16
+ | `tool connect <toolID>` | Connect a local tool (`local-filesystem`, `local-mysql`) to the API. Type is resolved from the server. |
17
17
 
18
18
  ### Flags
19
19
 
@@ -30,23 +30,49 @@ npx @infersec/conduit inference start --engine <type> --key <api-key> --source <
30
30
 
31
31
  #### `tool connect` flags
32
32
 
33
- | Flag | Required | Default | Notes |
34
- | ------------- | -------- | ------------------------- | ----------------------------------------------------------------------- |
35
- | `<toolID>` | Yes | - | Tool ID to connect (matches `TOOL_ID`). |
36
- | `--key` | Yes | - | API key (matches `API_KEY`). |
37
- | `--path` | No | `.` (current dir) | Filesystem base path (matches `TOOL_PATH`). Paths are confined to this. |
38
- | `--read-only` | No | `false` | Expose only read operations (matches `READ_ONLY`). |
39
- | `--api-url` | No | `https://api.infersec.ai` | API base URL (matches `API_URL`). |
33
+ Common flags (all tool types):
34
+
35
+ | Flag | Required | Default | Notes |
36
+ | ----------- | -------- | ------------------------- | --------------------------------------- |
37
+ | `<toolID>` | Yes | - | Tool ID to connect (matches `TOOL_ID`). |
38
+ | `--key` | Yes | - | API key (matches `API_KEY`). |
39
+ | `--api-url` | No | `https://api.infersec.ai` | API base URL (matches `API_URL`). |
40
+
41
+ `local-filesystem` flags:
42
+
43
+ | Flag | Required | Default | Notes |
44
+ | ------------- | -------- | ----------------- | ----------------------------------------------------------------------- |
45
+ | `--path` | No | `.` (current dir) | Filesystem base path (matches `TOOL_PATH`). Paths are confined to this. |
46
+ | `--read-only` | No | `false` | Expose only read operations (matches `READ_ONLY`). |
47
+
48
+ `local-mysql` flags (MySQL/MariaDB). Defaults to read-only; use `--allow` to enable writes:
49
+
50
+ | Flag | Required | Default | Notes |
51
+ | -------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------ |
52
+ | `--url` | One of url/host | - | Connection URL `mysql://user:pass@host:3306/db` (matches `MYSQL_URL`). Prefer `MYSQL_URL` for secrets. |
53
+ | `--host` | One of url/host | - | Host (matches `MYSQL_HOST`). |
54
+ | `--port` | No | `3306` | Port (matches `MYSQL_PORT`). |
55
+ | `--user` | With host | - | User (matches `MYSQL_USER`). |
56
+ | `--password` | With host | - | Password (matches `MYSQL_PASSWORD`). Prefer `MYSQL_PASSWORD` to avoid shell history exposure. |
57
+ | `--database` | No | - | Database name (matches `MYSQL_DATABASE`). |
58
+ | `--allow` | No | _(none)_ | Write operations to enable (csv) or `all` (matches `MYSQL_ALLOW`). Read-only if unset. |
59
+ | `--pool-max` | No | `5` | Pool connection limit (matches `MYSQL_POOL_MAX`). |
60
+ | `--max-rows` | No | `1000` | Max rows returned per query (matches `MYSQL_MAX_ROWS`). |
61
+ | `--query-timeout-ms` | No | `30000` | Per-query timeout in ms (matches `MYSQL_QUERY_TIMEOUT_MS`). |
40
62
 
41
63
  ### Examples
42
64
 
43
- | Scenario | Command |
44
- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
45
- | Required only | `npx @infersec/conduit inference start --engine vllm --key <api-key> --source <source-id>` |
46
- | Custom root/port | `npx @infersec/conduit inference start --engine vllm --key <api-key> --source <source-id> --root /data/infersec --port 9601` |
47
- | Custom engine/port | `npx @infersec/conduit inference start --engine vllm --key <api-key> --source <source-id> --port 9601 --engine-port 9701` |
48
- | Connect FS tool | `npx @infersec/conduit tool connect <tool-id> --key <api-key> --path ./` |
49
- | Read-only FS tool | `npx @infersec/conduit tool connect <tool-id> --key <api-key> --path ./ --read-only` |
65
+ | Scenario | Command |
66
+ | ------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
67
+ | Required only | `npx @infersec/conduit inference start --engine vllm --key <api-key> --source <source-id>` |
68
+ | Custom root/port | `npx @infersec/conduit inference start --engine vllm --key <api-key> --source <source-id> --root /data/infersec --port 9601` |
69
+ | Custom engine/port | `npx @infersec/conduit inference start --engine vllm --key <api-key> --source <source-id> --port 9601 --engine-port 9701` |
70
+ | Connect FS tool | `npx @infersec/conduit tool connect <tool-id> --key <api-key> --path ./` |
71
+ | Read-only FS tool | `npx @infersec/conduit tool connect <tool-id> --key <api-key> --path ./ --read-only` |
72
+ | Connect MySQL tool | `MYSQL_URL=mysql://user:pass@host:3306/db npx @infersec/conduit tool connect <tool-id> --key <api-key>` |
73
+ | MySQL + writes | `MYSQL_URL=mysql://user:pass@host:3306/db npx @infersec/conduit tool connect <tool-id> --key <api-key> --allow insert,update,sql` |
74
+
75
+ Credentials are best supplied via the `MYSQL_*` environment variables (or `MYSQL_URL`) rather than `--password`/`--url` flags, to avoid exposing them in process listings and shell history.
50
76
 
51
77
  ## Environment variables
52
78
 
@@ -64,12 +90,34 @@ npx @infersec/conduit inference start --engine <type> --key <api-key> --source <
64
90
 
65
91
  ### `tool connect` environment variables
66
92
 
67
- | Variable | Required | Default | Notes |
68
- | ----------- | -------- | ------------------------- | ---------------------------------------------------- |
69
- | `API_KEY` | Yes | - | API key (matches `--key`). |
70
- | `TOOL_ID` | Yes | - | Tool ID to connect (matches `<toolID>` positional). |
71
- | `TOOL_PATH` | No | `.` | Filesystem base path (matches `--path`). |
72
- | `READ_ONLY` | No | `false` | Expose only read operations (matches `--read-only`). |
73
- | `API_URL` | No | `https://api.infersec.ai` | API base URL (matches `--api-url`). |
93
+ Common:
94
+
95
+ | Variable | Required | Default | Notes |
96
+ | --------- | -------- | ------------------------- | --------------------------------------------------- |
97
+ | `API_KEY` | Yes | - | API key (matches `--key`). |
98
+ | `TOOL_ID` | Yes | - | Tool ID to connect (matches `<toolID>` positional). |
99
+ | `API_URL` | No | `https://api.infersec.ai` | API base URL (matches `--api-url`). |
100
+
101
+ `local-filesystem`:
102
+
103
+ | Variable | Required | Default | Notes |
104
+ | ----------- | -------- | ------- | ---------------------------------------------------- |
105
+ | `TOOL_PATH` | No | `.` | Filesystem base path (matches `--path`). |
106
+ | `READ_ONLY` | No | `false` | Expose only read operations (matches `--read-only`). |
107
+
108
+ `local-mysql`:
109
+
110
+ | Variable | Required | Default | Notes |
111
+ | ------------------------ | --------------- | -------- | ------------------------------------------------------- |
112
+ | `MYSQL_URL` | One of url/host | - | Connection URL (matches `--url`). |
113
+ | `MYSQL_HOST` | One of url/host | - | Host (matches `--host`). |
114
+ | `MYSQL_PORT` | No | `3306` | Port (matches `--port`). |
115
+ | `MYSQL_USER` | With host | - | User (matches `--user`). |
116
+ | `MYSQL_PASSWORD` | With host | - | Password (matches `--password`). |
117
+ | `MYSQL_DATABASE` | No | - | Database name (matches `--database`). |
118
+ | `MYSQL_ALLOW` | No | _(none)_ | Write ops csv / `all` (matches `--allow`). |
119
+ | `MYSQL_POOL_MAX` | No | `5` | Pool connection limit (matches `--pool-max`). |
120
+ | `MYSQL_MAX_ROWS` | No | `1000` | Max rows per query (matches `--max-rows`). |
121
+ | `MYSQL_QUERY_TIMEOUT_MS` | No | `30000` | Per-query timeout in ms (matches `--query-timeout-ms`). |
74
122
 
75
123
  CLI flags override environment variables when both are provided.