-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,40 @@ | ||
# Open Domains CLI | ||
Register free subdomains with Open Domains from your command line. | ||
|
||
## Getting Started | ||
|
||
Using the Open Domains CLI is easy! | ||
|
||
All you need to do is run the following command: | ||
|
||
```bash | ||
npm install @open-domains/cli -g | ||
``` | ||
|
||
...and that's it! | ||
|
||
## Using Commands | ||
|
||
All of the CLI commands start with `open-domains`. | ||
|
||
> You can also use the alias `od` instead. | ||
To show the help menu, in your terminal run this command: | ||
|
||
```bash | ||
open-domains help | ||
``` | ||
|
||
### Debugging | ||
|
||
If you are having issues using the CLI, follow these simple steps: | ||
|
||
1. Run the debug command | ||
|
||
```bash | ||
open-domains debug | ||
``` | ||
|
||
2. Open an issue | ||
|
||
Open an issue stating your issue and provide the output from the debug command as well. |