Package Exports
- devkick
- devkick/src/devkick.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (devkick) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
devKick
devKick is a colorful, interactive CLI that runs quick checks and startup tasks for your Docker, web, and Python projects so you can get to coding faster.
Getting Started
- Install globally:
npm install -g devkick- Run in your project (from the project root):
devkick startdevKick is interactive – it will ask before running commands like git pull, npm install, npm start, docker-compose up, or pip install.
What devKick does
Detects your project type
- Docker projects: based on
Dockerfileordocker-compose.yml - Web/Node projects: based on
package.json - Python projects: based on
requirements.txtorpyproject.toml - If nothing is detected, it lets you choose (Docker / Web / Python).
- Docker projects: based on
Runs general environment checks
- Looks for a
.envfile and loads it if present. - Checks for Git and whether you’re inside a repo.
- Warns about uncommitted changes and can optionally run
git pull.
- Looks for a
Runs project-specific helpers
- Docker
- Checks whether Docker is installed.
- Verifies the Docker daemon is reachable.
- If
docker-compose.ymlexists, can rundocker-compose up -d.
- Web (Node)
- Confirms Node.js is installed.
- If
node_modulesis missing, can runnpm install. - Can start your dev server via
npm start.
- Python
- Checks for Python (
python3orpython). - If
requirements.txtis present, can runpip install -r requirements.txt. - Prints a quick tip for creating a virtual env.
- Checks for Python (
- Docker
Optional editor launch
- If the
codeCLI is available, can open the project in VS Code (code .).
- If the
Requirements
- Node.js >= 14
- A POSIX-style shell or terminal (macOS, Linux, WSL, or similar)
- For best results, run
devkickinside a Git repo at your project root.
Usage examples
- Node/web app:
cd my-web-app
devkick start- Docker project:
cd my-docker-app
devkick start- Python project:
cd my-python-app
devkick startTips & Notes
- devKick never runs heavy commands without asking first – you stay in control.
- It cannot auto-start Docker Desktop; if Docker isn’t running, you’ll be prompted to start it manually.
- You can safely re-run
devkick startas often as you like while you’re working on a project.
Contributing & Support
- Source code / issues:
https://github.com/TheRiseCollection/dev-kick-plugin - Homepage / info:
https://www.therisecollection.co/portfolio/devkick
Bug reports and pull requests are welcome.
Changelog
- 1.0.7 – Add npm badges and small README polish.