Skip to main content

Quickstart

info

The English user guide is currently in beta preview. Most of the documents have been automatically translated from the Japanese version. Should you find any inaccuracies, please reach out to Flatt Security.

This page walks you through getting Takumi Runner set up and running your first workflow.

Prerequisites​

To use Takumi Runner, the following conditions must be met:

  • You have a Shisho Cloud organization and a user account belonging to it
  • You have admin permissions on the GitHub Organization
  • Your Takumi subscription is active

Steps​

1. Enable the Runner Feature​

Open Runner from the Shisho Cloud console sidebar and go to the Setup tab. A setup wizard will appear — complete the first step to enable the Runner feature.

Runner setup wizard

2. Install the GitHub App​

In the next step of the setup wizard, click the Install GitHub App button. You will be redirected to the GitHub installation page.

  1. Select the scope for which to enable the Runner:
    • Choose All repositories to enable for all repositories
    • Choose Only select repositories to enable for specific repositories only
  2. Click Install to complete the installation
info

Installing the GitHub App requires Owner permissions on the GitHub Organization. If you do not have the required permissions, request the installation from the Organization admin. After admin approval, you can link the app from the Shisho Cloud console under Settings > Service Integrations > CI/CD Integration by selecting Link existing GitHub App.

For details on the access permissions the GitHub App requests, see GitHub Integration > GitHub App Permissions.

3. Edit Your Workflow File​

Change runs-on to takumi-runner in your existing workflow file (.github/workflows/*.yml):

jobs:
  build:
    runs-on: takumi-runner
    steps:
      - uses: actions/checkout@v4
      - run: npm install
      - run: npm test

4. Run the Workflow​

Push code or trigger the workflow manually on GitHub. Takumi Runner will automatically pick up the job and run it on a secure VM.

5. Check the Traces​

Once the workflow completes, the job execution history appears under Runner > Jobs in the Shisho Cloud console.

Job list

Click a job to view the overview screen, where you can see process executions, network connections, and file accesses.

Job overview

The Timeline tab shows each workflow step and its associated traces.

Job timeline

Next Steps​

Last updated on