Repository navigation
getting started installation
Complete installation instructions for ConcordIO tools and packages.
⚠️ Development-Time Toolchain
ConcordIO is a build-time dependency only. It runs during compilation and CI/CD to generate code, but does NOT deploy to production. The tools and tasks execute during the build process and are not bundled into your application binaries.
-
.NET 10 SDK or later
- Download from dotnet.microsoft.com
- Verify:
dotnet --version
-
nuget CLI - Required for
breakingandget-speccommands- Windows:
choco install nuget.commandline - macOS:
brew install nuget - Linux: Download from nuget.org
- Windows:
Install the tool globally so it's available from any directory:
dotnet tool install --global ConcordIO.ToolVerify the installation:
concordio --versionUpdate to the latest version:
dotnet tool update --global ConcordIO.Tooldotnet tool uninstall --global ConcordIO.ToolFor project-specific tooling, install as a local tool:
# Create a tool manifest if it doesn't exist
dotnet new tool-manifest
# Install the tool locally
dotnet tool install ConcordIO.ToolRun with dotnet prefix:
dotnet concordio --versionUpdate local tool:
dotnet tool update ConcordIO.ToolPin to a specific version in your project:
dotnet tool install ConcordIO.Tool --version 1.2.3Or in .config/dotnet-tools.json:
{
"version": 1,
"isRoot": true,
"tools": {
"concordio.tool": {
"version": "1.2.3",
"commands": [
"concordio"
]
}
}
}For generating C# types from AsyncAPI specifications:
<ItemGroup>
<PackageReference Include="ConcordIO.AsyncApi.Client" Version="0.1.0">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>For generating AsyncAPI specifications from .NET types:
<ItemGroup>
<PackageReference Include="ConcordIO.AsyncApi.Server" Version="0.1.0">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>ConcordIO packages are published to GitHub Packages by default. Add the source:
dotnet nuget add source https://nuget.pkg.github.com/LevDevIO/index.json \
--name github-levdevioOr in NuGet.config:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="github-levdevio" value="https://nuget.pkg.github.com/LevDevIO/index.json" />
</packageSources>
</configuration>Authentication: While this repository is public, GitHub Packages typically requires authentication even for consuming public packages. You may need to configure a Personal Access Token (PAT) with read:packages scope:
- Create a PAT: https://github.com/settings/tokens/new (select
read:packagesscope) - Add to
NuGet.config:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="github-levdevio" value="https://nuget.pkg.github.com/LevDevIO/index.json" />
</packageSources>
<packageSourceCredentials>
<github-levdevio>
<add key="Username" value="YOUR_GITHUB_USERNAME" />
<add key="ClearTextPassword" value="YOUR_PAT_TOKEN" />
</github-levdevio>
</packageSourceCredentials>
</configuration>Alternatively, use the dotnet nuget add source command with --username and --password flags.
Stable releases are published to NuGet.org and don't require additional configuration:
dotnet tool install --global ConcordIO.ToolNo special configuration needed. Ensure:
- .NET SDK is installed
- PowerShell or Command Prompt is used
- PATH includes .NET tools:
%USERPROFILE%\.dotnet\tools
Ensure tools are on PATH:
echo 'export PATH="$PATH:$HOME/.dotnet/tools"' >> ~/.zshrc
source ~/.zshrcFor Apple Silicon (M1/M2):
- .NET SDK includes ARM64 support
- ConcordIO bundles universal macOS binaries
Add tools to PATH in .bashrc or .zshrc:
echo 'export PATH="$PATH:$HOME/.dotnet/tools"' >> ~/.bashrc
source ~/.bashrcDockerfile example:
FROM mcr.microsoft.com/dotnet/sdk:10.0
# Install ConcordIO
RUN dotnet tool install --global ConcordIO.Tool
# Add to PATH
ENV PATH="$PATH:/root/.dotnet/tools"
# Verify installation
RUN concordio --versionFor environments without internet access:
- Download the package on an online machine:
dotnet tool install --global ConcordIO.Tool --tool-path ./tools-
Copy
./toolsto the offline machine -
Install from local files:
dotnet tool install --global ConcordIO.Tool --add-source ./toolsSymptom: concordio: command not found
Solution: Add .NET tools to PATH:
# Linux/macOS
export PATH="$PATH:$HOME/.dotnet/tools"
# Windows (PowerShell)
$env:PATH += ";$env:USERPROFILE\.dotnet\tools"Symptom: Permission denied when installing
Solution: Don't use sudo with dotnet tool install. It should install to your user directory.
Symptom: A newer version of the tool is already installed
Solution: Update instead of install:
dotnet tool update --global ConcordIO.ToolOr uninstall first:
dotnet tool uninstall --global ConcordIO.Tool
dotnet tool install --global ConcordIO.ToolSymptom: 401 Unauthorized when restoring packages
Solution: For private feeds, configure authentication:
dotnet nuget add source https://your-feed.com/nuget \
--name private-feed \
--username USERNAME \
--password PASSWORD \
--store-password-in-clear-textCheck everything is working:
# CLI tool
concordio --version
# .NET SDK
dotnet --version
# nuget CLI (optional)
nuget help
# List installed tools
dotnet tool list --global- 🚀 Quick Start Guide - Get started in 5 minutes
- 🎯 When to Use ConcordIO - Understanding use cases
- 🏗️ Core Concepts - Learn the fundamentals
- 🛠️ CLI Tool Guide - Complete CLI reference