Skip to content

Commit

Permalink
TASK: template-project docs
Browse files Browse the repository at this point in the history
  • Loading branch information
skurfuerst committed Dec 23, 2024
1 parent 0bac0b4 commit 4c479e5
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# drydock - Docker Debugging Tools

This is a set of useful CLI tools to help debugging Docker containers:
This is a set of useful CLI tools developed at [sandstorm.de](https://sandstorm.de) to make our development
processes smoother and easier. It is mostly tooling to help debugging Docker containers, though starting with
v4, we also have some general-purpose tooling for working with template projects.

**General Tooling**

- `drydock execroot`: Like `docker exec`, but *always* spawn a root shell
- `drydock vscode`: Open Visual Studio Code (with the [Containers extension](https://aka.ms/vscode-remote/download/containers)),
allowing to edit any file as root
- `drydock template-project sync`: Keep your project in sync with changes from a template project using AI (ALPHA)


**PHP Specific Tooling**

Expand Down Expand Up @@ -40,6 +44,7 @@ We have tested the tools in OSX. They also can work on other platforms, but were
* [`drydock vscode [containername]`](https://sandstorm.github.io/drydock/#vscode)
* [`drydock spx [containername]`](https://sandstorm.github.io/drydock/#spx)
* [`drydock xdebug [containername]`](https://sandstorm.github.io/drydock/#xdebug)
* [`drydock template-project sync`](https://sandstorm.github.io/drydock/#template-project) **(NEW)**


## License
Expand Down

0 comments on commit 4c479e5

Please sign in to comment.