Skip to content

Commit 1f81f66

Browse files
bsuttongitbook-bot
authored andcommitted
GitBook: [#189] No subject
1 parent 0dd3b68 commit 1f81f66

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ DCli is the console SDK for Dart.
44

55
Use the DCli console SDK to build cross platform, command line (CLI) applications and scripts using the Dart programming language.
66

7-
The DCli (pronounced d-kleye) console SDK includes command line tools and an extensive API for building CLI apps.
7+
The DCli (pronounced d-cli) console SDK includes command line tools and an extensive API for building CLI apps.
88

99
The DCli console SDK as featured on Jermaine Oppong package of the week vlog.
1010

@@ -18,8 +18,8 @@ OnePub allows you to privately share dart packages between your own projects or
1818

1919
Try it for free and publish your first private package in seconds.
2020

21-
| ![](<.gitbook/assets/OnePub.dev Logo – reversed FA (1) (1) (1) (1).svg>) | <p>Publish a private package in six commands:</p><p><mark style="color:green;"><code>dart pub global activate onepub</code></mark></p><p><mark style="color:green;"><code>onepub login</code></mark></p><p><mark style="color:green;"><code>dcli create --template=full mytool</code></mark></p><p><mark style="color:green;"><code>cd mytool</code></mark></p><p><mark style="color:green;"><code>onepub pub private</code></mark></p><p><mark style="color:green;"><code>dart pub publish</code></mark></p> |
22-
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| ![](<.gitbook/assets/OnePub.dev Logo – reversed FA (1) (1).svg>) | <p>Publish a private package in six commands:</p><p><mark style="color:green;"><code>dart pub global activate onepub</code></mark></p><p><mark style="color:green;"><code>onepub login</code></mark></p><p><mark style="color:green;"><code>dcli create --template=full mytool</code></mark></p><p><mark style="color:green;"><code>cd mytool</code></mark></p><p><mark style="color:green;"><code>onepub pub private</code></mark></p><p><mark style="color:green;"><code>dart pub publish</code></mark></p> |
22+
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2323

2424
You can now install `mytool` on any system with dart installed:
2525

doc/dcli-tools-1/dcli-compile.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The compile command will compile your DCli script(s) into a native executable an
44

55
The resulting native application can be copied to any binary compatible OS and run without requiring Dart or DCli to be installed.
66

7-
Dart complied applications are also super fast.
7+
Dart compiled applications are also super fast.
88

99
Usage: `dcli compile [-nc, -i, -o] [<script path.dart>, <script path.dart>,...]`
1010

@@ -66,12 +66,20 @@ dcli compile --package critical_test
6666
critical_test
6767
```
6868

69+
The compiled package will be automatically copied into the \~/.dcli/bin directory which is on your PATH.
70+
6971
Compiling a globally activated package has a number of uses:
7072

7173
* faster startup time
7274
* you are able to copy the resulting executable to any binary compatible machine and run it without installing Dart
7375
* If you switch Dart versions then the executable will still run even if the package isn't compatible with the installed Dart version. This can be useful if you need to run an old version of dart but want access to the latest version of a Dart CLI package.
7476

77+
When compiling a package DCli will create an executable for each of the scripts listed in the packages pubspec.yaml `executables` section.
78+
79+
{% hint style="info" %}
80+
Ensure that \~/.dcli/bin is on your PATH and is before \~/.pub-cache or the globally activate version will run rather than you compiled version.
81+
{% endhint %}
82+
7583
## Flags:
7684

7785
### --noprepare | -nc :

0 commit comments

Comments
 (0)