Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit 1243947

Browse files
committed
Add a not on the state of the project
Signed-off-by: Vincent Demeester <[email protected]>
1 parent 740cc94 commit 1243947

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@
55

66
A Go library for Docker Compose. It does everything the command-line tool does, but from within Go -- read Compose files, start them, scale them, etc.
77

8+
**Note: This is not really maintained anymore — the reason are diverse but mainly lack of time from the maintainers**
9+
10+
The current state is the following :
11+
- The `libcompose` CLI should considered abandonned. The `v2` parsing is incomplete and `v3` parsing is missing.
12+
- The official compose Go parser implementation is on [`docker/cli`](https://github.com/docker/cli/tree/master/cli/compose) but only support `v3` version of the compose format.
13+
14+
What is the work that is needed:
15+
- Remove the cli code (thus removing dependencies to `docker/cli` )
16+
- Clearer separation of packages : `parsing`, `conversion` (to docker api or swarm api), `execution` (`Up`, `Down`, … behaviors)
17+
- Add support for all compose format version (v1, v2.x, v3.x)
18+
- Switch to either `golang/dep` or `go mod` for dependencies (removing the `vendor` folder)
19+
- *(bonus)* extract the [`docker/cli`](https://github.com/docker/cli/tree/master/cli/compose) code here and vendor this library into `docker/cli`.
20+
21+
If you are interested to work on `libcompose`, feel free to ping me (over twitter @vdemeest), I'll definitely do code reviews and help as much as I can 😉.
22+
823
**Note: This is experimental and not intended to replace the [Docker Compose](https://github.com/docker/compose) command-line tool. If you're looking to use Compose, head over to the [Compose installation instructions](http://docs.docker.com/compose/install/) to get started with it.**
924

1025
Here is a list of known project that uses `libcompose`:

0 commit comments

Comments
 (0)