docker
Version, currently 0.2.04 versions
- 0.2.0latestJun 10, 2021
- 0.1.2not indexedJun 10, 2021
- 0.1.1not indexedJun 10, 2021
- 0.1.0not indexedJun 10, 2021
github.com/jeromegn/docker.cr
Docker API client in Crystal.
27 stars
0 dependents
License: MIT
Installation
# Add this to your shard.yml
dependencies:
docker:
github: jeromegn/docker.cr
version: ~> 0.2.0Then run:
shards installshard.yml
- Crystal
>= 1.0.0- License
- MIT
- Author
- Jerome Gravel-Niquet <jeromegn@gmail.com>
Dependencies
Runtime Dependencies
- json_mapping*github: crystal-lang/json_mapping.cr
Development Dependencies
- webmock*github: manastech/webmock.cr, branch: masterdev
README
# Crystal Docker API client
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
docker:
github: jeromegn/docker.cr
```
## Status: Developer Preview
This is not nearly complete. Just got the initial connecting working and simple casting. I added a few commands as a proof of concept.
This shard extends OpenSSL and HTTP::Client a little bit to support Docker's SSL method (TLS V1.)
## Usage
```crystal
require "docker"
```
### Options
By default, options will be taken from the environment variables:
```
DOCKER_URL or DOCKER_HOST
DOCKER_VERIFY_TLS
DOCKER_CERT_PATH
```
but they can also be set manually like:
```crystal
Docker.client.url = "tcp://192.168.99.100:2376"
Docker.client.verify_tls = true
Docker.client.cert_path = "#{ENV["HOME"]}/.docker"
```
If nothing is set, this client will use the unix socket.
### Info
```crystal
Docker.client.info.container # => Returns container count
```
### Containers
```crystal
Docker.client.containers # => Array of Docker::Container
container = Docker.client.containers.first
p container # => #<Docker::Container:0x10f6a3ea0 @id="cbbeb51f25b4c91b61e6d1b5fc0c1c2bb470ccd8aaf5dc4a57885f35f21d7245", @names=["api"], @image="ruby" ...>
container.stop
container.start
container.restart
container.kill
```
## Contributing
1. Fork it ( https://github.com/jeromegn/docker.cr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [jeromegn](https://github.com/jeromegn) Jerome Gravel-Niquet - creator, maintainer
Documentation
Built from the current release. The first visit to a release nobody has asked for starts its build.
Links
This release
- Version
0.2.0- Tagged
- Jun 10, 2021
- Commit
63891cc8fc18- Crystal
>= 1.0.0- Indexed
- yes
Dependents
No indexed shard depends on this one yet.
Repository
github.com/jeromegn/docker.cr
Metadata
- Created
- Aug 12, 2026
- Updated
- Aug 12, 2026
- Synced
- Aug 12, 2026
- Versions
- 4