mirror of
https://github.com/msoedov/agentic_security.git
synced 2026-06-24 22:29:56 +02:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ed0b3b5dbe |
+5
-36
@@ -1,54 +1,23 @@
|
||||
# Getting Started
|
||||
|
||||
Welcome to Agentic Security! This guide will help you orient yourself within the project and start using the tool quickly.
|
||||
|
||||
## Project Overview
|
||||
|
||||
Agentic Security is an open-source vulnerability scanner for Large Language Models (LLMs). It provides both a command line interface and a FastAPI server so you can probe models for weaknesses such as jailbreaks or refusal patterns. The tool supports multimodal attacks, multi-step scans and reinforcement-learning based probes.
|
||||
|
||||
## Repository Layout
|
||||
|
||||
```
|
||||
agentic_security/
|
||||
├── __main__.py - CLI entry point
|
||||
├── app.py - FastAPI app assembly
|
||||
├── lib.py - SecurityScanner and utilities
|
||||
├── config.py - Configuration handling
|
||||
├── core/ - app state and logging helpers
|
||||
├── probe_actor/ - scanning logic and RL modules
|
||||
├── probe_data/ - dataset registry and loaders
|
||||
├── routes/ - API endpoints
|
||||
└── ui/ - Web UI assets (Vue)
|
||||
```
|
||||
|
||||
`tests/` contains unit tests, and `docs/` houses the project documentation.
|
||||
Welcome to Agentic Security! This guide will help you get started with using the tool.
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Ensure you have completed the [installation](installation.md) steps.
|
||||
2. Run the following command to start the application:
|
||||
1. Run the following command to start the application:
|
||||
```bash
|
||||
agentic_security
|
||||
```
|
||||
The server will start on `http://localhost:8718`.
|
||||
3. Explore available commands with:
|
||||
```bash
|
||||
agentic_security --help
|
||||
```
|
||||
1. Access the application at `http://localhost:8718`.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
- To view available commands, run:
|
||||
- To view available commands, use:
|
||||
```bash
|
||||
agentic_security --help
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Review the [Quickstart Guide](quickstart.md) for a fast setup walkthrough.
|
||||
- Check [http_spec.md](http_spec.md) to learn how LLM endpoints are described.
|
||||
- Browse the `probe_actor` and `probe_data` modules to understand how scanning works and how datasets are loaded.
|
||||
- Explore the [Configuration](configuration.md) section to customize your setup.
|
||||
- Run the tests in `tests/` to verify your environment once dependencies are installed.
|
||||
|
||||
This guide should give you a solid foundation for exploring and extending Agentic Security. For more details, see the rest of the documentation.
|
||||
Explore the [Configuration](configuration.md) section to customize your setup.
|
||||
|
||||
Generated
+4
-4
@@ -4372,14 +4372,14 @@ files = [
|
||||
|
||||
[[package]]
|
||||
name = "urllib3"
|
||||
version = "2.2.2"
|
||||
version = "2.5.0"
|
||||
description = "HTTP library with thread-safe connection pooling, file post, and more."
|
||||
optional = false
|
||||
python-versions = ">=3.8"
|
||||
python-versions = ">=3.9"
|
||||
groups = ["main", "dev"]
|
||||
files = [
|
||||
{file = "urllib3-2.2.2-py3-none-any.whl", hash = "sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472"},
|
||||
{file = "urllib3-2.2.2.tar.gz", hash = "sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168"},
|
||||
{file = "urllib3-2.5.0-py3-none-any.whl", hash = "sha256:e6b01673c0fa6a13e374b50871808eb3bf7046c4b125b216f6bf1cc604cff0dc"},
|
||||
{file = "urllib3-2.5.0.tar.gz", hash = "sha256:3fc47733c7e419d4bc3f6b3dc2b4f890bb743906a30d56ba4a5bfa4bbff92760"},
|
||||
]
|
||||
|
||||
[package.extras]
|
||||
|
||||
Reference in New Issue
Block a user