KeylineClient 0.0.1

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package KeylineClient --version 0.0.1
                    


                    

                
NuGet\Install-Package KeylineClient -Version 0.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="KeylineClient" Version="0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="KeylineClient" Version="0.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="KeylineClient" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add KeylineClient --version 0.0.1
                    


                    

                
#r "nuget: KeylineClient, 0.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package KeylineClient@0.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=KeylineClient&version=0.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=KeylineClient&version=0.0.1
                    


                            Install as a Cake Tool

KeylineNet

A .NET client library for interacting with the Keyline API.

Features

  • Simple API Client: Easy-to-use client for interacting with Keyline projects and applications
  • Authentication Support: Built-in support for service user authentication with JWT tokens
  • Type-Safe: Strongly typed API with interfaces for better IntelliSense support
  • Modern .NET: Built on .NET 9.0

Installation

Clone the repository and build the solution:

git clone https://github.com/The127/KeylineNet.git
cd KeylineNet
dotnet build

Usage

Basic Example

using KeylineClient;
using KeylineClient.auth;

// Create Keyline client
var keylineClient = new ClientFactory("http://localhost:8081", "keyline")
    .WithServiceUserAuth(
        "admin-ui",
        "test-service-user", 
        PrivateKeyProviderFactory.Static(PrivateKeyPem, "9ca0ce76-7f8d-4675-8af7-3b34b04ac976")
    ).Create();


// Use the client to interact with Keyline
var applications = await keylineClient.Projects["system"].Applications.List();
applications.Items.ForEach(x => Console.WriteLine(x.Name));

Development

Prerequisites

  • .NET 9.0 SDK or later
  • Docker (optional, for running the PostgreSQL database)

Running Tests

dotnet test

Running the Example Application

The repository includes an example application demonstrating basic usage:

cd ExampleApp
dotnet run

Database Setup

The project includes a Docker Compose file for running a PostgreSQL database:

docker-compose up -d

Project Structure

  • KeylineClient: The main client library
  • ExampleApp: Example application demonstrating usage
  • UnitTests: Unit tests for the client library
  • IntegrationTests: Integration tests

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.0.2 291 11/10/2025
0.0.1 175 11/8/2025