Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marghidanu/docr
Crystal library for Docker Engine API
https://github.com/marghidanu/docr
crystal docker docker-engine-api
Last synced: about 1 month ago
JSON representation
Crystal library for Docker Engine API
- Host: GitHub
- URL: https://github.com/marghidanu/docr
- Owner: marghidanu
- License: mit
- Created: 2021-02-02T08:18:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T13:53:46.000Z (8 months ago)
- Last Synced: 2024-05-03T17:20:04.425Z (8 months ago)
- Topics: crystal, docker, docker-engine-api
- Language: Crystal
- Homepage: https://marghidanu.github.io/docr/
- Size: 83 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# docr
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`:
```yaml
dependencies:
docr:
github: marghidanu/docr
```
2. Run `shards install`
## Usage
```crystal
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
- [Tudor Marghidanu](https://github.com/marghidanu) - creator and maintainer
- [Troy Sornson](https://github.com/Vici37) - contributor