@artemiskit/cli
v0.1.8
Published
Command-line interface for ArtemisKit LLM evaluation toolkit
Maintainers
Readme
@artemiskit/cli
Command-line interface for ArtemisKit - the LLM evaluation toolkit.
Installation
npm install -g @artemiskit/cli
# or
bun add -g @artemiskit/cliQuick Start
# Initialize configuration
artemiskit init
# Run a test scenario
artemiskit run my-scenario.yaml
# Run red team security tests
artemiskit redteam my-scenario.yaml
# Run stress tests
artemiskit stress my-scenario.yaml --iterations 100 --concurrency 10Commands
artemiskit run <scenario>
Execute scenario-based evaluations against LLM providers.
artemiskit run tests/auth-flow.yaml --provider openai --model gpt-4oOptions:
--provider <name>- LLM provider (openai, azure-openai, anthropic)--model <name>- Model to use--redact- Enable PII/sensitive data redaction--redact-patterns <patterns...>- Custom redaction patterns--config <path>- Path to config file
artemiskit redteam <scenario>
Run adversarial security tests including prompt injection, jailbreak attempts, and data extraction probes.
artemiskit redteam tests/chatbot.yaml --count 5Options:
-c, --count <n>- Number of mutated prompts per case (default: 5)--mutations <types...>- Mutations to apply (typo, role-spoof, instruction-flip, cot-injection)--redact- Enable PII/sensitive data redaction
artemiskit stress <scenario>
Perform load and stress testing with detailed latency metrics.
artemiskit stress tests/api.yaml --requests 100 --concurrency 10Options:
-n, --requests <n>- Total number of requests to make-c, --concurrency <n>- Number of concurrent requests (default: 10)-d, --duration <seconds>- Duration to run the test (default: 30)--ramp-up <seconds>- Ramp-up time (default: 5)--redact- Enable PII/sensitive data redaction
artemiskit report <manifest>
Regenerate HTML reports from saved run manifests.
artemiskit report artemis-runs/my-project/abc123.jsonartemiskit history
View past test runs.
artemiskit history --limit 10artemiskit compare <run1> <run2>
Compare results between two test runs.
artemiskit compare abc123 def456artemiskit init
Initialize ArtemisKit configuration in your project.
artemiskit initScenario File Format
name: my-test-scenario
description: Test user authentication flow
config:
provider: openai
model: gpt-4o
cases:
- id: login-success
prompt: "How do I log in to my account?"
expect:
- type: contains
value: "password"
- type: contains
value: "username"
- id: password-reset
prompt: "I forgot my password"
expect:
- type: contains
value: "reset"Configuration
Create artemis.config.yaml in your project root:
project: my-project
provider: openai
model: gpt-4o
providers:
openai:
apiKey: ${OPENAI_API_KEY}
azure-openai:
apiKey: ${AZURE_OPENAI_API_KEY}
resourceName: ${AZURE_OPENAI_RESOURCE}
deploymentName: ${AZURE_OPENAI_DEPLOYMENT}
apiVersion: "2024-02-15-preview"
storage:
type: local
basePath: ./artemis-runsEnvironment Variables
OPENAI_API_KEY- OpenAI API keyAZURE_OPENAI_API_KEY- Azure OpenAI API keyAZURE_OPENAI_RESOURCE- Azure resource nameAZURE_OPENAI_DEPLOYMENT- Azure deployment nameANTHROPIC_API_KEY- Anthropic API key
Aliases
The CLI is also available as akit:
akit run my-scenario.yamlRelated Packages
@artemiskit/core- Core runtime and evaluators@artemiskit/adapter-openai- OpenAI/Azure adapter@artemiskit/adapter-vercel-ai- Vercel AI SDK adapter (20+ providers)@artemiskit/adapter-anthropic- Anthropic Claude adapter@artemiskit/redteam- Security testing@artemiskit/reports- HTML report generation
License
Apache-2.0
