Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/cli/commands/help.md
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
```
43 changes: 43 additions & 0 deletions docs/cli/commands/init.md
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
```
35 changes: 35 additions & 0 deletions docs/cli/commands/login.md
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==
```
29 changes: 29 additions & 0 deletions docs/cli/commands/logout.md
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
```
8 changes: 5 additions & 3 deletions docs/cli/commands/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: nest publish
sidebar_label: publish
---

Publish your module to the nest.land registry
Publish your module to the nest.land registry.

```shell script
nest publish [version]
Expand Down Expand Up @@ -59,7 +59,9 @@ nest publish 1.2.3 --pre beta # module@1.2.3-beta.0
nest publish patch --pre rc # module@1.0.1-rc.0
nest publish minor --pre asdf # module@1.1.0-asdf.0
nest publish major --pre pre # module@1.0.1-pre.0
```

nest --deno ^1.7.1
nest --deno ">=1.2.3 <1.7.0"
```shell script
nest publish --deno ^1.7.1
nest publish --deno ">=1.2.3 <1.7.0"
```
29 changes: 29 additions & 0 deletions docs/cli/commands/setup.md
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
```
31 changes: 31 additions & 0 deletions docs/cli/commands/switch.md
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
```
16 changes: 16 additions & 0 deletions docs/cli/commands/sync.md
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
```
23 changes: 23 additions & 0 deletions docs/cli/commands/upgrade.md
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
```
4 changes: 4 additions & 0 deletions docs/cli/configuration/data.json.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: data.json
sidebar_label: data.json
---
4 changes: 4 additions & 0 deletions docs/cli/configuration/users.json.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: users.json
sidebar_label: users.json
---
2 changes: 1 addition & 1 deletion docs/nest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ You can find our source code [here](https://github.com/nestdotland).

## Something missing / Questions ?

If you find issues with the documentation or have suggestions on how to improve the documentation or the project in general, please [file an issue](https://github.com/nestdotland/nest.land/issues/new/choose) for us, start a new [GitHub Discussion](https://github.com/nestdotland/nest.land/discussions) or [tweet at us](https://twitter.com/nestdotland)!
If you find issues with the documentation or have suggestions on how to improve the documentation or the project in general, please [file an issue](https://github.com/nestdotland/nest.land/issues/new/choose) for us, start a new [GitHub Discussion](https://github.com/nestdotland/nest.land/discussions), or [tweet at us](https://twitter.com/nestdotland)!
14 changes: 13 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,24 @@ module.exports = {
"Nest CLI": [
"cli/README",
{
Commands: ["cli/commands/publish"],
Commands: [
"cli/commands/help",
"cli/commands/init",
"cli/commands/login",
"cli/commands/logout",
"cli/commands/publish",
"cli/commands/setup",
"cli/commands/switch",
"cli/commands/sync",
"cli/commands/upgrade",
],
},
{
"Configuration files": [
"cli/configuration/module.json",
"cli/configuration/ignore",
"cli/configuration/data.json",
"cli/configuration/users.json",
],
},
"cli/faq",
Expand Down