Skip to content

Commit 8a48701

Browse files
committed
add bin scripts to README
1 parent 0ef9c57 commit 8a48701

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,16 @@ Use this mode if you are making code changes to CKAN and either creating new ext
9898

9999
To develop local extensions use the `docker-compose.dev.yml` file with help from the scripts under `bin`:
100100

101+
dev script | description
102+
--- | ---
103+
`bin/ckan …` | exec `ckan` cli within the ckan-dev container
104+
`bin/compose …` | dev docker compose commands
105+
`bin/generate_extension` | generate extension in `src` directory
106+
`bin/install_src` | install all extensions from `src` directory (ckan-dev does not need to be running)
107+
`bin/reload` | reload ckan within the ckan-dev container without restarting
108+
`bin/restart` | shut down and restart the whole ckan-dev container (loads new values from .env)
109+
`bin/shell` | exec bash prompt within the ckan-dev container
110+
101111
To build the images:
102112

103113
bin/compose build

0 commit comments

Comments
 (0)