You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 3e5522b
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: AGENTS.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@
5
5
- Core SDK code lives in `splunklib/` (client bindings, search commands, modular input helpers). Keep new modules close to their domain peers (e.g., searchcommand utilities under `splunklib/searchcommands`).
6
6
-`splunklib/ai/` is the primary active development area - a provider-agnostic LLM agent framework for embedding AI into Splunk Apps.
7
7
- Tests are split by scope: `tests/unit/`, `tests/integration/`, `tests/system/`, and `tests/searchcommands/` for app-style fixtures. Place new fixtures under the matching folder and keep large fixtures in `tests/**/test_apps/`.
8
+
- See `splunklib/ai/README.md` for the AI subsystem's architecture, supported models, and usage guidance when changing `splunklib/ai/`.
9
+
- See `docs/` for the Sphinx API reference when changing or documenting public SDK modules.
8
10
9
11
## Package Manager
10
12
@@ -16,16 +18,16 @@ make install
16
18
17
19
If you manually edit `pyproject.toml` to add/remove/update dependencies, run `make install` afterwards to update `uv.lock`.
18
20
19
-
The `Makefile` wraps `uv` commands - prefer `make` targets over invoking `uv` directly where a target exists.
21
+
The `Makefile` wraps `uv` commands - see `./Makefile` for available targets, and prefer `make` targets over invoking `uv` directly where a target exists.
20
22
21
23
## Build, Test, and Development Commands
22
24
23
-
See the `Makefile` for all available targets. Common ones:
25
+
See `./Makefile` for all available targets. Common ones:
24
26
25
27
-`make install` - set up / update virtualenv
26
28
-`make test` - run the full pytest suite.
27
-
-`make test-unit` - unit tests only; fastest feedback loop.
28
-
-`make test-integration` - integration + system coverage; requires Splunk services available (see docker targets).
29
+
-`make test-unit` - unit tests only; fastest feedback loop. See `tests/unit/` for unit-test cases when adding or updating unit tests.
30
+
-`make test-integration` - integration + system coverage; requires Splunk services available (see `tests/integration/` for integration test cases and `./Makefile` for Docker targets).
29
31
-`make test-ai` - AI subsystem tests only.
30
32
-`make docker-start` / `make docker-down` - spin up or stop the Splunk test container. Make sure the instance is live before running integration tests.
0 commit comments