README
¶
Interface Definition Language Repository (idl-repository)
A repository and command line interface (CLI) for storing and fetching interface definitions in various formats. (Protocol Buffers, Avro, OpenAPI, etc.)
Quickstart
Initialize a project for the first time
Initializing a project creates a new idl.yaml file with the project name and repository URL.
idl init my-project http://idl-repository.example.com
Read more about idl init.
Pull dependencies into your project
Pull IDLs into your project.
idl pull
Read more about idl pull.
Push project to the repository
Push IDLs in your project to the configured repository.
idl push
Read more about idl push.
Documentation
Read the full documentation for idl.
Read the full documentation for the repository service, idl-repository.
Docker image
If you want to run idl inside a Docker container, you can do so:
docker run --rm -v $PWD:/data syncromatics/idl:__VERSION__ --help
Where __VERSION__ is a valid tag from the syncromatics/idl Docker repository
Building
You'll need Docker to build the Docker image for the repository.
Download dependencies
go get -t -v ./...
Build the CLI and repository server
make build
Code of Conduct
We are committed to fostering an open and welcoming environment. Please read our code of conduct before participating in or contributing to this project.
Contributing
We welcome contributions and collaboration on this project. Please read our contributor's guide to understand how best to work with us.
License and Authors
GMV Syncromatics Engineering
This software is made available by GMV Syncromatics Engineering under the MIT license.
Directories