@debugg-ai/cli
Version:
CLI tool for running DebuggAI tests in CI/CD environments
100 lines • 3.34 kB
TypeScript
/**
* @debugg-ai/cli - CLI tool for running DebuggAI tests in CI/CD environments
*
* This module provides programmatic access to the DebuggAI testing functionality.
* For CLI usage, use the `debugg-ai` command after installing the package.
*/
export { CLIBackendClient } from './backend/cli/client';
export { GitAnalyzer } from './lib/git-analyzer';
export { TestManager } from './lib/test-manager';
export { TunnelManager } from './lib/tunnel-manager';
export { ServerManager } from './lib/server-manager';
export { WorkflowOrchestrator } from './lib/workflow-orchestrator';
export type { CLIClientConfig } from './backend/cli/client';
export interface Chunk {
startLine: number;
endLine: number;
contents: string;
filePath?: string;
}
export type { WorkingChange, CommitInfo, BranchInfo, WorkingChanges, GitAnalyzerOptions, PRCommitInfo, PRCommitSequence } from './lib/git-analyzer';
export type { TestManagerOptions, TestResult, PRSequenceResult } from './lib/test-manager';
export type { TunnelConfig, TunnelInfo, TunnelManagerOptions } from './lib/tunnel-manager';
export type { ServerConfig, ServerStatus, ServerManagerOptions } from './lib/server-manager';
export type { WorkflowConfig, WorkflowResult, WorkflowOptions } from './lib/workflow-orchestrator';
/**
* Default configuration values
*/
export declare const DEFAULT_CONFIG: {
readonly BASE_URL: "https://api.debugg.ai";
readonly TEST_OUTPUT_DIR: "tests/debugg-ai";
readonly SERVER_TIMEOUT: 30000;
readonly MAX_TEST_WAIT_TIME: 600000;
readonly POLL_INTERVAL: 5000;
readonly DEFAULT_SERVER_PORT: 3000;
readonly DEFAULT_SERVER_WAIT_TIME: 60000;
};
/**
* Environment variable names used by the CLI
*/
export declare const ENV_VARS: {
readonly API_KEY: "DEBUGGAI_API_KEY";
readonly BASE_URL: "DEBUGGAI_BASE_URL";
readonly GITHUB_SHA: "GITHUB_SHA";
readonly GITHUB_REF_NAME: "GITHUB_REF_NAME";
readonly GITHUB_HEAD_REF: "GITHUB_HEAD_REF";
readonly NGROK_AUTH_TOKEN: "NGROK_AUTH_TOKEN";
};
/**
* Quick start function for programmatic usage
*/
export declare function runDebuggAITests(options: {
apiKey: string;
repoPath?: string;
baseUrl?: string;
testOutputDir?: string;
waitForServer?: boolean;
serverPort?: number;
maxTestWaitTime?: number;
downloadArtifacts?: boolean;
prSequence?: boolean;
baseBranch?: string;
headBranch?: string;
}): Promise<{
success: boolean;
suiteUuid?: string;
testFiles?: string[];
error?: string;
}>;
/**
* Execute complete workflow with server management and tunnel setup
*/
export declare function runWorkflow(options: {
apiKey: string;
repoPath?: string;
baseUrl?: string;
testOutputDir?: string;
downloadArtifacts?: boolean;
prSequence?: boolean;
baseBranch?: string;
headBranch?: string;
serverCommand?: string;
serverArgs?: string[];
serverPort?: number;
ngrokAuthToken?: string;
ngrokSubdomain?: string;
ngrokDomain?: string;
baseDomain?: string;
maxTestWaitTime?: number;
serverTimeout?: number;
cleanup?: boolean;
verbose?: boolean;
}): Promise<{
success: boolean;
tunnelUrl?: string;
serverUrl?: string;
suiteUuid?: string;
testFiles?: string[];
error?: string;
}>;
//# sourceMappingURL=index.d.ts.map