github.com/marghidanu/docr

Crystal library for Docker Engine API

18 stars
4 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  docr:
    github: marghidanu/docr
    version: ~> 0.1.4

Then run:

shards install

shard.yml

Crystal
>= 0.36.1
License
MIT
Author
Tudor

Dependencies

Runtime Dependencies

README

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

docr

CI

Docker client for Crystal.

Description

Remaining issues:

  • [ ] Test all endpoint functions
  • [ ] Make sure models are complete
  • [ ] Extend client to support calls over network

PRs are always welcomed!

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      docr:
        github: marghidanu/docr
  2. Run shards install

Usage

require "docr"

Supported API calls

Containers

  • [x] ContainerList
  • [x] ContainerCreate
  • [x] ContainerInspect
  • [x] ContainerTop
  • [x] ContainerLogs
  • [x] ContainerChanges
  • [ ] ContainerStats
  • [x] ContainerStart
  • [x] ContainerStop
  • [x] ContainerRestart
  • [x] ContainerKill
  • [ ] ContainerUpdate
  • [ ] ContainerRename
  • [x] ContainerPause
  • [x] ContainerUnpause
  • [ ] ContainerAttach
  • [x] ContainerWait
  • [x] ContainerDelete

Images

  • [x] ImageList
  • [x] ImageBuild
  • [x] ImageCreate
  • [x] ImageInspect
  • [x] ImageHistory
  • [x] ImagePush
  • [x] ImageTag
  • [x] ImageDelete

Networks

  • [x] NetworkList
  • [x] NetworkCreate
  • [x] NetworkInspect
  • [ ] NetworkConnect
  • [ ] NetworkDisconnect
  • [x] NetworkDelete

Volumes

  • [x] VolumeList
  • [x] VolumeCreate
  • [x] VolumeInspect
  • [x] VolumeDelete

Exec

  • [x] ContainerExec
  • [x] ExecStart
  • [x] ExecInspect

System

  • [x] SystemAuth
  • [x] SystemInfo
  • [x] SystemVersion
  • [x] SystemPing
  • [x] SystemEvents
  • [ ] SystemDataUsage

Contributors