TypeScript scenarios - Arga

Create a scenario

Generation mode options require arga-sdk 0.1.3 or later. Create with a natural language prompt. Arga generates the seed config.

const scenario = await client.scenarios.create({
  name: 'E-commerce checkout',
  prompt: 'A Stripe account with 3 customers on different plans',
  generationMode: 'thorough',  // optional; defaults to 'fast'
  description: 'For testing checkout flows',  // optional
  tags: ['checkout', 'stripe'],               // optional
});

Fast is the default and prioritizes speed. Choose Thorough for complex requirements when a longer wait is acceptable. The mode only affects prompt generation. The SDK exports the ScenarioGenerationMode type. Or create with an explicit seed config:

const scenario = await client.scenarios.create({
  name: 'Support channel',
  twins: ['slack'],
  seedConfig: {
    slack: {
      channels: [{ name: 'support', messages: ['Help needed'] }],
    },
  },
});

List scenarios

// All scenarios
const scenarios = await client.scenarios.list();

// Filter by twin or tag
const stripeScenarios = await client.scenarios.list({ twin: 'stripe' });
const checkoutScenarios = await client.scenarios.list({ tag: 'checkout' });

Get a scenario

const scenario = await client.scenarios.get('scenario-id');
console.log(scenario.name, scenario.twins, scenario.seedConfig);

Use a scenario when provisioning twins

Use a saved scenario to seed a short-lived twin session:

const { runId } = await client.twins.provision({
  twins: ['stripe', 'slack'],
  scenarioId: 'scenario-id',
});

const status = await client.twins.getStatus(runId);
if (status.status === 'ready') {
  for (const [name, twin] of Object.entries(status.twins)) {
    console.log(`${name}: ${twin.baseUrl}`);
    console.log(`  Admin: ${twin.adminUrl}`);
    console.log(`  Env vars:`, twin.envVars);
  }
}

Persistent twin environment

Create or return the persistent environment attached to a Scenario:

const environment = await client.scenarios.ensureTwinEnvironment('scenario-id', {
  twins: ['stripe', 'slack'],
  public: true,
});

Inspect, reseed, list, or tear down persistent environments:

const current = await client.scenarios.getTwinEnvironment('scenario-id');
const reseeded = await client.scenarios.reseedTwinEnvironment('scenario-id');
const environments = await client.scenarios.listTwinEnvironments();
const deleted = await client.scenarios.deleteTwinEnvironment('scenario-id');