Skip to content

0install/0install-dotnet

Repository files navigation

Zero Install .NET

API documentation Build status
Zero Install is a decentralized cross-platform software installation system. You can learn more at 0install.net.

This is the .NET implementation of Zero Install. It can be used as a command-line tool on various platforms or be embedded into .NET applications as a set of libraries. It provides the basis for Zero Install for Windows.

Command-line

Zero Install .NET provides the 0install command-line tool. There are a number of ways you can get it:

  • You can get a .NET Framework version of the 0install command by downloading Zero Install for Windows. (recommended)

  • If you already have some version of Zero Install (.NET-based or otherwise) on your system you can use it to download and run a .NET 6 version of the 0install command like this:

    0install run https://apps.0install.net/0install/0install-dotnet.xml
    
  • You can also manually install .NET 6.0 and then download a Zero Install .NET Release, extract the archive and run:

    dotnet 0install.dll
    

NuGet packages

You can use these NuGet packages to integrate Zero Install features into your own application:

ZeroInstall.Model
Data model for the feed format.

ZeroInstall.Client
Client for invoking Zero Install commands from within other applications.

ZeroInstall.Store
Management of implementation caches, digital signatures, etc..

ZeroInstall.Archives
Extracting and building archives (.zip, .tar, etc.).

ZeroInstall.Services
Core services like solving dependencies, downloading implementations and execution selections.
Zero Install itself is built upon this API. You can use the API to integrate Zero Install features into your own application.

ZeroInstall.DesktopIntegration
Integrating applications with desktop environments (creating menu entries, etc.).

ZeroInstall.Commands
Command-line interface for Zero Install.
The binary in this package serves both as an actual CLI and a library for building other clients.

ZeroInstall.Publish
Utilities for creating and modifying feed files.
The Zero Install Publishing Tools (including the Feed Editor) are built upon this library. You can use this to automate complex feed creation/update tasks.

For more information read the Zero Install .NET API documentation.

Building

The source code is in src/, config for building the API documentation is in doc/ and generated artifacts are placed in artifacts/.
The source code does not contain version numbers. Instead the version is determined during CI using GitVersion.

To build run .\build.ps1 or ./build.sh (.NET SDK is automatically downloaded if missing).

Contributing

We welcome contributions to this project such as bug reports, recommendations, pull requests and translations. If you have any questions feel free to pitch in on our friendly mailing list.

This repository contains an EditorConfig file. Please make sure to use an editor that supports it to ensure consistent code style, file encoding, etc.. For full tooling support for all style and naming conventions consider using JetBrains' ReSharper or Rider products.