1- <p align =" center " >
2- <a href =" https://github.com/HashLoad/boss/blob/master/img/png/sized/Boss%20Logo%20-%20128px.png " >
3- <img alt="Boss" src="https://github.com/HashLoad/boss/blob/master/img/png/sized/Boss%20Logo%20-%20128px.png">
4- </a >
5- </p ><br >
6- <p align =" center " >
7- <b >Boss</b > is an open source dependency manager inspired by <a href =" https://www.npmjs.com/ " >npm</a ><br >for projects developed in <b >Delphi</b > and <b >Lazarus</b >.
8- </p ><br >
9- <p align =" center " >
10- <a href =" https://t.me/hashload " >
11- <img src="https://img.shields.io/badge/telegram-join%20channel-7289DA?style=flat-square">
12- </a >
13- </p >
14-
15- ![ Go] ( https://github.com/hashload/boss/workflows/Go/badge.svg )
16-
17- ### [ Getting started] ( https://medium.com/@matheusarendthunsche/come%C3%A7ando-com-o-boss-72aad9bcc13 )
18-
19- Installation:
20- * Download [ setup] ( https://github.com/hashload/boss/releases )
21- * Just type ` boss ` in cmd
22- * (Optional) Install a [ Boss Delphi IDE complement] ( https://github.com/hashload/boss-ide )
23-
24- ## Available Commands
1+ # Boss
2+
3+ ![ Boss] [ bossLogo ]
4+ ![ GitHub release (latest by date)] [ latestReleaseBadge ]
5+ ![ GitHub Release Date] [ releaseDateBadge ]
6+ ![ GitHub repo size] [ repoSizeBadge ]
7+ ![ GitHub All Releases] [ totalDownloadsBadge ]
8+ ![ GitHub] [ githubLicenseBadge ]
9+ ![ GitHub issues] [ githubIssuesBadge ]
10+ ![ GitHub pull requests] [ githubPullRequestsBadge ]
11+ ![ GitHub contributors] [ githubContributorsBadge ]
12+ ![ Github Stars] [ repoStarsBadge ]
13+
14+ _ Boss_ is an open source dependency manager inspired by [ npm] ( https://www.npmjs.com/ ) for projects developed in _ Delphi_ and _ Lazarus_ .
15+
16+ [ ![ Boss] [ telegramBadge ]] [ telegramLink ]
17+
18+ <!-- getting start with emoji -->
19+
20+ ## 🚀 Getting started
21+
22+ We have a [ Getting Started] ( https://medium.com/@matheusarendthunsche/come%C3%A7ando-com-o-boss-72aad9bcc13 ) article to help you get started with Boss.
23+
24+ ## 📦 Installation
25+
26+ - Download [ setup] ( https://github.com/hashload/boss/releases )
27+ - Just type ` boss ` in the terminal
28+ - (Optional) Install a [ Boss Delphi IDE complement] ( https://github.com/hashload/boss-ide )
29+
30+ Or you can use the following the steps below:
31+
32+ - Download the latest version of the [ Boss] ( https://github.com/hashload/boss/releases )
33+ - Extract the files to a folder
34+ - Add the folder to the system path
35+ - Run the command ` boss ` in the terminal
36+
37+ ## 📚 Available Commands
2538
2639### > Init
40+
2741This command initialize a new project. Add ` -q ` or ` --quiet ` to initialize the boss with default values.
28- ```
42+
43+ ``` shell
2944boss init
3045boss init -q
3146boss init --quiet
3247```
3348
3449### > Install
50+
3551This command install a new dependency
36- ```
52+
53+ ``` shell
3754boss install < dependency>
3855```
56+
3957The dependency is case insensitive. For example, ` boss install horse ` is the same as the ` boss install HORSE ` command.
58+
4059``` pascal
4160boss install horse // By default, look for the Horse project within the GitHub Hashload organization.
4261boss install fake/horse // By default, look for the Horse project within the Fake GitHub organization.
4362boss install gitlab.com/fake/horse // By default, searches for the Horse project within the Fake GitLab organization.
4463boss install https://gitlab.com/fake/horse // You can also pass the full URL for installation
4564```
46- ###### Aliases: i, add
65+
66+ > Aliases: i, add
4767
4868### > Uninstall
69+
4970This command uninstall a dependency
50- ```
71+
72+ ``` sh
5173boss uninstall < dependency>
5274```
53- ###### Aliases: remove, rm, r, un, unlink
75+
76+ > Aliases: remove, rm, r, un, unlink
5477
5578### > Cache
79+
5680This command removes the cache
57- ```
81+
82+ ``` sh
5883 boss config cache rm
5984```
60- ###### Aliases: remove, rm, r
85+
86+ > Aliases: remove, rm, r
6187
6288### > Dependencies
89+
6390This command print all dependencies and your versions. To see versions, add aliases ` -v `
64- ```
91+
92+ ``` shell
6593boss dependencies
6694boss dependencies -v
6795```
68- ###### Aliases: dep, ls, list, ll, la
96+
97+ > Aliases: dep, ls, list, ll, la
6998
7099### > Version
100+
71101This command show the client version
72- ```
102+
103+ ``` shell
73104boss v
74105boss version
75106boss -v
76107boss --version
77108```
78- ###### Aliases: v
109+
110+ > Aliases: v
79111
80112### > Update
113+
81114This command update installed dependencies
82- ```
115+
116+ ``` sh
83117boss update
84118```
85- ###### Aliases: up
119+
120+ > Aliases: up
86121
87122### > Upgrade
123+
88124This command upgrade the client latest version. Add ` --dev ` to upgrade to the latest pre-release.
89- ```
125+
126+ ``` sh
90127boss upgrade
91128boss upgrade --dev
92129```
93130
94131### > login
132+
95133This command Register login to repo
96- ```
134+
135+ ``` sh
97136boss login < repo>
98137boss adduser < repo>
99138boss add-user < repo>
100139boss login < repo> -u UserName -p Password
101140boss login < repo> -k PrivateKey -p PassPhrase
102141```
103- ###### Aliases: adduser, add-user
142+
143+ > Aliases: adduser, add-user
104144
105145## Flags
106146
107147### > Global
148+
108149This flag defines a global environment
109- ```
150+
151+ ``` sh
110152boss --global
111153```
112- ###### Aliases: -g
154+
155+ > Aliases: -g
113156
114157### > Help
158+
115159This is a helper for boss. Use ` boss <command> --help ` for more information about a command.
116- ```
160+
161+ ``` sh
117162boss --help
118163```
119- ###### Aliases: -h
164+
165+ > Aliases: -h
120166
121167## Another commands
122- ```
168+
169+ ``` sh
123170delphi Configure Delphi version
124- gc Garbage collector
171+ gc Garbage collector
125172publish Publish package to registry
126173run Run cmd script
127174```
128175
129176## Samples
130- ```
177+
178+ ``` sh
131179boss install horse
132180boss install horse:1.0.0
133181boss install -g delphi-docker
@@ -136,15 +184,27 @@ boss install -g boss-ide
136184
137185## Using [ semantic versioning] ( https://semver.org/ ) to specify update types your package can accept
138186
139- You can specify which update types your package can accept from dependencies in your package’ s boss.json file.
187+ You can specify which update types your package can accept from dependencies in your package' s boss.json file.
140188
141189For example, to specify acceptable version ranges up to 1.0.4, use the following syntax:
142- * Patch releases: 1.0 or 1.0.x or ~ 1.0.4
143- * Minor releases: 1 or 1.x or ^1.0.4
144- * Major releases: * or x
190+
191+ - Patch releases: 1.0 or 1.0.x or ~ 1.0.4
192+ - Minor releases: 1 or 1.x or ^1.0.4
193+ - Major releases: \* or x
145194
146195## 💻 Code Contributors
147196
148- <a href =" https://github.com/Hashload/boss/graphs/contributors " >
149- <img src =" https://contrib.rocks/image?repo=Hashload/boss " />
150- </a >
197+ ![ GitHub Contributors Image] ( https://contrib.rocks/image?repo=Hashload/boss )
198+
199+ [ githubContributorsBadge ] : https://img.shields.io/github/contributors/hashload/boss
200+ [ bossLogo ] : ./assets/png/sized/boss-logo-128px.png
201+ [ latestReleaseBadge ] : https://img.shields.io/github/v/release/hashload/boss
202+ [ releaseDateBadge ] : https://img.shields.io/github/release-date/hashload/boss
203+ [ repoSizeBadge ] : https://img.shields.io/github/repo-size/hashload/boss
204+ [ totalDownloadsBadge ] : https://img.shields.io/github/downloads/hashload/boss/total
205+ [ githubLicenseBadge ] : https://img.shields.io/github/license/hashload/boss
206+ [ githubIssuesBadge ] : https://img.shields.io/github/issues/hashload/boss
207+ [ githubPullRequestsBadge ] : https://img.shields.io/github/issues-pr/hashload/boss
208+ [ telegramBadge ] : https://img.shields.io/badge/telegram-join%20channel-7289DA?style=flat-square
209+ [ telegramLink ] : https://t.me/hashload
210+ [ repoStarsBadge ] : https://img.shields.io/github/stars/hashload/boss?style=social
0 commit comments