Skip to main content

Installation & Integration

Ariftly is a SaaS platform — there is no agent or daemon to install. All scanning happens in Ariftly's infrastructure. You integrate with Ariftly via:

  • The REST API (language-agnostic)
  • The official SDKs (JavaScript/TypeScript, Python — more coming)
  • CI/CD plugins (GitHub Actions, GitLab CI)
  • The web dashboard

JavaScript / TypeScript SDK​

npm install @ariftly/sdk
# or
yarn add @ariftly/sdk

Basic usage​

import { Ariftly } from '@ariftly/sdk';

const client = new Ariftly({ apiKey: process.env.ARIFTLY_API_KEY });

const scan = await client.scans.create({
  projectId: 'proj_abc123',
  detectors: ['accessibility', 'security', 'ai_readiness'],
});

// Wait for completion
const result = await client.scans.waitForCompletion(scan.scanId);
console.log(`Risk Score: ${result.riskScore}`);

Python SDK​

pip install ariftly
import os
from ariftly import Ariftly

client = Ariftly(api_key=os.environ["ARIFTLY_API_KEY"])

scan = client.scans.create(
    project_id="proj_abc123",
    detectors=["accessibility", "security", "ai_readiness"]
)

result = client.scans.wait_for_completion(scan.scan_id)
print(f"Risk Score: {result.risk_score}")

Environment variables​

All Ariftly clients read from environment variables by default:

VariableDescription
ARIFTLY_API_KEYYour API key (required)
ARIFTLY_BASE_URLAPI base URL (default: https://api.ariftly.io)
ARIFTLY_TIMEOUTRequest timeout in ms (default: 30000)

API base URL​

All REST API requests go to:

https://api.ariftly.io/v1

See the API Reference for the full endpoint list.