Skip to content

Quick Start Guide

Get your first Kiket workflow running in about five minutes.

1. Create an Account

  1. Visit kiket.dev/signup.
  2. Sign in with GitHub or email.
  3. Create your organization (e.g., acme).

2. Connect GitHub

  1. Go to Organization → Integrations → GitHub.
  2. Paste a personal access token with repo, workflow, and admin:repo_hook scopes.
  3. Click Sync Repositories so Kiket can list repos during project creation.

3. Prepare a Repository

Create a repository (or reuse an existing one) and add a .kiket/ folder:

.kiket/
├── workflows/
│   └── default.yaml
└── boards/
    └── development.yaml

.kiket/workflows/default.yaml

workflow: development
version: 1
states:
  - backlog
  - in_progress:
      auto_assign: true
      wip_limit: 4
  - review:
      require_approval: 1
  - done:
      on_enter:
        - run: close_issue
actions:
  close_issue:
    kind: system
    command: issues.close
transitions:
  - { from: backlog, to: in_progress }
  - { from: in_progress, to: review }
  - { from: review, to: done }

.kiket/boards/development.yaml

name: Development Board
workflow: development
columns:
  - { key: backlog, name: Backlog }
  - { key: in_progress, name: In Progress, wip_limit: 4 }
  - { key: review, name: Review, wip_limit: 3 }
  - { key: done, name: Done }

Commit and push the repository to GitHub.

4. Create a Project

  1. In Kiket, go to Projects → New Project.
  2. Select the repository you just prepared (you can pick multiple repos if needed).
  3. Confirm the project name and create it. Kiket provisions WorkflowRepository and Repository records automatically.

5. Run the Initial Sync

  • The sync job starts automatically. Watch progress in Project → Activity.
  • Successful sync pulls workflows and boards into storage/workflow_sources/ and generates Kanban boards.

6. Create an Issue

  1. Open the new project.
  2. Click New Issue and add a title.
  3. Move the card across columns—each move executes the workflow transition defined in YAML.

7. Explore Analytics

In Analytics → Custom Query run: 

SELECT state, COUNT(*) AS issues
FROM issues
WHERE project = $project
GROUP BY state

You now have a repository-driven project with a workflow, board, and analytics ready to extend. Continue with Create Your First Workflow or Build Your First Extension for deeper dives.