About
Kiit CLI (command line interface) application to create Kiit projects
Links
Refer to https://www.kiit.dev/start/generators/ page on setup and the pages below
Page | Link | Notes |
---|---|---|
Site | https://www.kiit.dev/ | Main Site |
Setup | https://www.kiit.dev/start/start/#cli | Set up CLI |
Tools | https://www.kiit.dev/start/start/#generators | Set up Generator |
Source | https://github.com/slatekit/slatekit | Git Page for project |
Install
This is WIP ( work in progress ) and should be available very soon!
# WIP: This is just a test
brew tap slatekit/slatekit
brew install slatekit
Notes
- Ensure security -> privacy -> full disk access -> iterm2 ( of what ever terminal you use )
- Slow HomeBrew post install
- The install may be very slow with MacOS Catalina
Create
kiit new app -name="MyApp1" -package="company1.apps"
kiit new api -name="MyAPI1" -package="company1.apis"
kiit new cli -name="MyCLI1" -package="company1.apps"
kiit new env -name="MyApp2" -package="company1.apps"
kiit new job -name="MyJob1" -package="company1.jobs"
kiit new lib -name="MyLib1" -package="company1.libs"
kiit new orm -name="MyApp3" -package="company1.data"
Check
brew tap
brew info slatekit
Uninstall
brew uninstall slatekit
brew untap slatekit/slatekit
Publish
Steps to publish this CLI to make it available via HomeBrew Notes: These binaries are built at github.com/slatekit/slatekit Much of this can be automated ( WIP - work in progress )
Build Slate Kit
You have to build Slate Kit first
- ensure env variable is set to
export SLATEKIT_PROJECT_MODE=sources
( in mac .bashrc or .zshrc ) - checkout git repo for Slate Kit at https://github.com/slatekit/slatekit ( e.g.
~/git/slatekit/slatekit
) - cd into the https://github.com/slatekit/slatekit/src/lib/kotlin/slatekit directory
- open
~/git/slatekit/slatekit/src/lib/kotlin/slatekit/src/main/resources/env.conf
- change the version numbers to the version of slate kit for slatekit.version, slatekit.version.cli e.g. ( 2.1.3 )
- run
gradle clean build distZip
( to build the binaries ) - go to
~/git/slatekit/slatekit/src/lib/kotlin/slatekit/build/distributions
- unzip the zip file
slatekit.zip
to directoryslatekit
Package CLI
Once Slate Kit is built, there is a script to package the binaries and update the HomeBrew formula
- checkout this repo https://github.com/slatekit/slatekit-cli ( e.g. to
~/git/slatekit/slatekit-cli
) - on terminal move to build folder of slate kit
cd ~/git/slatekit/slatekit/build
- open
slatekit-package-cli.sh
and ensure you set the root directory variables - on terminal run the script
./slatekit-package-cli
( this will copy all needed files into the slatekit-cli project ) - commit the changes to slatekit-cli ( should have the env.conf and slate kit binaries/jars )
- create a release in github.com see https://github.com/slatekit/slatekit-cli/releases ( use version label format v2.1.3 )
Homebrew
Now that there is a relase of the CLI, we can package the HomeBrew formula
- checkout repo https://github.com/slatekit/homebrew-slatekit (
~/git/slatekit/homebrew-slatekit
) - open the release ( e.g. https://github.com/slatekit/slatekit-cli/releases/tag/v2.1.3 )
- right click on the zip file and get the link to it ( e.g.
Source code(tar.gz)
) - on terminal go to a temp directory ( e.g.
~/git/slatekit/tmp
) - download the url via curl ( e.g.
curl -L https://github.com/slatekit/slatekit-cli/archive/v2.1.3.tar.gz > v2.1.3.tar.gz
) - get the sha of the file run
shasum -a 256 v2.1.3.tar.gz
( e.g.01dfe9a24293ea82503d89142bf3ce9514932370bdacc425de6c90e50b43aa31
) - open file
slatekit.rb
in this homebrew-slatekit repo - change the version url and sha256 fields in the file to reflect the version and shasum above
- commit the changes