-
-
Notifications
You must be signed in to change notification settings - Fork 8
(WIP) Nest CLI doc #34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
SteelAlloy
wants to merge
8
commits into
main
Choose a base branch
from
docs/nest-cli
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
2793950
docs: :construction: WIP
SteelAlloy 4e7b5e3
chore: :art: file structure
SteelAlloy faf4850
chore: :truck: change doc structure
SteelAlloy 6fc34cf
feat: :sparkles: commands
SteelAlloy 6905ca4
feat: config files
SteelAlloy 10cfa4a
docs: :fire: remove autogenerated files
SteelAlloy 70a5dd7
fix: :bug: sidebar path
SteelAlloy 6b5c028
docs: :memo: config command
SteelAlloy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| title: nest help | ||
| sidebar_label: help | ||
| --- | ||
|
|
||
| Show the global help or the help of a sub-command. | ||
|
|
||
| ```shell script | ||
| nest help [...command] | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| argument | description | ||
| -------- | ----------- | ||
| ...command | A command or a sub-command | ||
|
|
||
| :::info | ||
| Show the global help if no command is provided | ||
| ::: | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest help | ||
| nest help login | ||
| nest help publish 1.2.5 --pre | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| title: nest init | ||
| sidebar_label: init | ||
| --- | ||
|
|
||
| Initiate a new module for the nest.land registry. Will create the necessary configuration files. | ||
|
|
||
| ```shell script | ||
| nest init | ||
| ``` | ||
|
|
||
| :::tip | ||
| Use [`nest setup`](./setup.md) if your module already exists ! | ||
| ::: | ||
|
|
||
| ## Prompts | ||
|
|
||
| ```script shell | ||
| Initialize directory ? > | ||
| ``` | ||
| Exits if `false` | ||
|
|
||
| ```script shell | ||
| Link to an existing module? > | ||
| ``` | ||
|
|
||
| :::info | ||
| If you answer `yes`, behaves in the same way as the [`nest setup`](./setup.md) command. | ||
| ::: | ||
|
|
||
| ```script shell | ||
| Module name > | ||
| Module full name > | ||
| Description > | ||
| Homepage > | ||
| Homepage > | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest init | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| title: nest login | ||
| sidebar_label: login | ||
| --- | ||
|
|
||
| Add an existing user account. | ||
|
|
||
| ```shell script | ||
| nest login [username] [token] | ||
| ``` | ||
|
|
||
| See [users.json](../configuration/users.json.md) for technical details. | ||
|
|
||
| :::note New to Nest.land? | ||
| [Create an account](https://nest.land/#). | ||
| ::: | ||
|
|
||
| ## Arguments | ||
|
|
||
| argument | description | ||
| -------- | ----------- | ||
| username | A username | ||
| token | A login token | ||
|
|
||
| :::info | ||
| If `[username]` or `[token]` is missing, you will be prompted to enter it. | ||
| ::: | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest login | ||
| nest login me | ||
| nest login me OltCnjbXVnkNYIr60/4IvA== | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: nest logout | ||
| sidebar_label: logout | ||
| --- | ||
|
|
||
| Remove an existing user account. | ||
|
|
||
| ```shell script | ||
| nest login [username] | ||
| ``` | ||
|
|
||
| See [users.json](../configuration/users.json.md) for technical details. | ||
|
|
||
| ## Arguments | ||
|
|
||
| argument | description | ||
| -------- | ----------- | ||
| username | A username | ||
|
|
||
| :::info | ||
| If `[username]` is missing, you will be prompted to enter it. | ||
| ::: | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest login | ||
| nest login me | ||
SteelAlloy marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: nest setup | ||
| sidebar_label: setup | ||
| --- | ||
|
|
||
| Link current directory to an existing module. | ||
|
|
||
| ```shell script | ||
| nest setup [author] [module] | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| argument | description | ||
| -------- | ----------- | ||
| author | A module author | ||
| module | A module name | ||
|
|
||
| :::info | ||
| If `[author]` or `[module]` is missing, you will be prompted to enter it. | ||
| ::: | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest setup | ||
| nest setup me | ||
| nest setup me my-module | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: nest switch | ||
| sidebar_label: switch | ||
| --- | ||
|
|
||
| Publish your module to the nest.land registry. | ||
|
|
||
| ```shell script | ||
| nest switch [username] | ||
| ``` | ||
|
|
||
| :::tip | ||
| Use this command when you need to work on multiple projects with different accounts. | ||
| ::: | ||
|
|
||
| ## Arguments | ||
|
|
||
| argument | description | ||
| -------- | ----------- | ||
| username | A username | ||
|
|
||
| :::info | ||
| If `[username]` is missing, you will be prompted to enter it. | ||
| ::: | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest switch | ||
| nest switch user12648 | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: nest sync | ||
| sidebar_label: sync | ||
| --- | ||
|
|
||
| Synchronize remote and local configuration. | ||
|
|
||
| ```shell script | ||
| nest sync | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest sync | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: nest upgrade | ||
| sidebar_label: upgrade | ||
| --- | ||
|
|
||
| Upgrade nest cli to the given version. | ||
|
|
||
| ```shell script | ||
| nest upgrade [version] | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| argument | default | description | ||
| -------- | ------- | ----------- | ||
| version | latest | A given semver version | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell script | ||
| nest upgrade | ||
| nest upgrade 1.0.0 | ||
| ``` |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: data.json | ||
| sidebar_label: data.json | ||
| --- |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: users.json | ||
| sidebar_label: users.json | ||
| --- |
This file contains hidden or 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
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.