Getting Started

This quickstart is for first-time users who want Devflow running in a repository, regardless of implementation language.

What You Will Achieve¶

By the end of this page you will:

initialize a repository with dwf init (auto-detect or explicit template)
run a local quality profile (check:pr)
generate a CI workflow from config (ci:generate)
validate CI workflow consistency (ci:check)

Step 1: Install Devflow¶

Follow Installation.

Step 2: Initialize Project Config and Starter CI¶

Recommended:

dwf init

This auto-detects project type in this order:

Cargo.toml -> rust
tsconfig.json -> tsc
package.json -> node

Explicit template selection:

dwf init rust
dwf init node
dwf init tsc
dwf init kotlin

What this writes:

devflow.toml
.github/workflows/ci.yml

Secure by Default¶

Every project initialized with dwf init is automatically “Hardened-by-Default”:

Vulnerability Scanning: Integrated Trivy gates for dependencies and containers.
Non-Root Execution: Containers run as a non-privileged dwfuser.
Least Privilege: GitHub Actions GITHUB_TOKEN restricted to contents: read.

See the Security and Hardening Deep Dive for more details.

Use --force to overwrite existing files:

dwf --force init rust

If you prefer manual setup, create devflow.toml in your repository root.

TypeScript example:

[project]
name = "my-ts-repo"
stack = ["node"]

[runtime]
# Runtime execution profile: container | host | auto
profile = "auto"

[targets]
pr = ["fmt:check", "lint:static", "build:debug", "test:unit"]
main = ["fmt:check", "lint:static", "build:release", "test:unit", "test:integration"]

[extensions.node]
source = "builtin"
required = true

Step 3: Run Local Quality Gate¶

dwf check:pr

What this does:

loads the targets.pr command list from devflow.toml
runs each listed command locally, in order
returns non-zero exit code if any command fails

What this does not do:

it does not call remote CI services
it does not push commits or modify your Git provider settings

Step 4: Generate and Validate CI Workflow¶

dwf ci:generate
dwf ci:check

Expected behavior:

ci:generate writes .github/workflows/ci.yml
re-running ci:generate re-syncs the file from current config
ci:check validates topology and detects drift between committed workflow and generated workflow

Step 5: Inspect Planned Profiles¶

dwf ci:plan

This prints the target profile names currently defined in [targets].

Step 6: GitHub Repository Standardization¶

Devflow helps you enforce best practices on your GitHub repository using Infrastructure-as-Code.

make gh-setup

This will:

Initialize Terraform in .github/settings/terraform.
Preview changes for branch protection, required status checks, and security settings.
Guide you on how to apply these settings using terraform apply.

Additionally, structured issue templates and community policies are now available in your .github directory and repository root.