Getting Started¶
Get up and running with Kiket in minutes. This section covers everything you need to go from zero to your first workflow.
Prerequisites¶
Before you begin:
- GitHub account — Kiket syncs workflows from your Git repositories
- Basic YAML knowledge — Workflows are defined in YAML files
- Text editor — VS Code with the YAML extension recommended
Choose Your Path¶
-
5-Minute Quick Start
The fastest way to see Kiket in action. Create an account, connect a repo, and run your first workflow.
-
Core Concepts
Understand the mental model. Learn how organizations, projects, workflows, and extensions fit together.
-
Your First Workflow
Step-by-step guide to defining states, transitions, and automations in YAML.
-
Migrating from Another Tool
Moving from Jira, GitHub Projects, or Linear? We'll help you bring your data.
What You'll Build¶
By the end of this section, you'll have:
- A Kiket account with your organization set up
- A connected repository with workflow definitions
- A working workflow with states, transitions, and automations
- A Kanban board visualizing your workflow
- Understanding of how to extend and customize
Key Concepts Preview¶
Everything Lives in Git¶
Your workflows, boards, and analytics are YAML files in your repository:
your-repo/
└── .kiket/
├── workflows/
│ └── development.yaml
├── boards/
│ └── sprint-board.yaml
└── analytics/
└── team-metrics.yaml
When you push changes, Kiket automatically syncs and applies your configuration.
Workflows Define State Machines¶
A workflow describes how issues move through states:
workflow: development
states:
- backlog
- in_progress
- review
- done
transitions:
- from: backlog
to: in_progress
- from: in_progress
to: review
- from: review
to: done
Extensions Add Integrations¶
Extensions connect Kiket to external services. They run on your infrastructure:
extension:
id: com.yourcompany.slack-notifications
triggers:
- event: issue.transitioned
handlers:
notify:
endpoint: /webhooks/notify
Estimated Time¶
| Guide | Time | What You'll Learn |
|---|---|---|
| Quick Start | 5 min | Account setup, first project |
| Core Concepts | 10 min | Architecture and mental model |
| Your First Workflow | 15 min | Complete workflow with automations |
| Next Steps | 5 min | Where to go from here |
Need Help?¶
- Community Discord — Ask questions, get real-time help
- GitHub Discussions — Browse community Q&A
- Troubleshooting Guide — Common issues and solutions
Ready? Start with the Quick Start →