durbok/noodl-docs
1
0
Fork 0
mirror of https://github.com/noodlapp/noodl-docs.git synced 2026-01-12 07:12:53 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Feat: Remove CLI docs (#57)

Browse Source
This commit is contained in:
kotte
2024-01-15 13:15:50 +01:00
committed by GitHub
parent ddc2f503f6
commit bd60459a3c
11 changed files with 3 additions and 351 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
cli/commands/build/README.md
View File

@@ -1,30 +0,0 @@
---
title: CLI Command build
hide_title: true
---
# Command: build
Build a Noodl app without having Noodl installed and with custom build settings.
## Synopsis
```
noodl-cli build <projectDir> <outputDir> [--parseEndpoint <endpoint>] [--parseAppId <appId>]
```
### Configuration
#### `parseEndpoint`
- Default: undefined
- Type: String
The endpoint to the Parse Platform instance.
#### `parseAppId`
- Default: undefined
- Type: String
The App ID for the Parse Platform instance.

41
cli/commands/new/README.md
View File

@@ -1,41 +0,0 @@
---
title: CLI Command new
hide_title: true
---
# Command: new
Create a new Noodl module template.
### Example
```bash
# Create a React Module in the relative "./my-module" folder.
noodl-cli new react-lib ./my-module
```
### Available Templates
#### `react-lib`
Create a module with React and Logic Component support.
#### `lib`
Create a module with Logic Component support.
## Synopsis
```
noodl-cli new <template> <path> [--name <name>]
```
### Configuration
#### `name`
- Default: folder name
- Type: String
- Alias: `-n`
The module name.

16
cli/commands/parse/README.md
View File

@@ -1,16 +0,0 @@
---
title: CLI Command parse
hide_title: true
---
# Command: parse
Interact with a Parse Platform instance.
I would recommend looking at [noodl-parse-schema-sync (Github)](https://github.com/noodlapp/noodl-parse-schema-sync) since that is more up to date.
## Synopsis
```
noodl-cli parse sync-schema
```

43
cli/commands/project/clone.md
View File

@@ -1,43 +0,0 @@
---
title: CLI Command project list
hide_title: true
---
# Command: project list
Clone a Noodl project via git.
:::tip
For this to work it is required that git is install on the machine.
:::
## Synopsis
```
noodl-cli project clone <project-id> <path> [--username <username>] [--password <password>] [--shell <shell>]
```
### Configuration
#### `username`
- Default: undefined
- Type: String
Noodl username.
#### `password`
- Default: undefined
- Type: String
Noodl password.
#### `shell`
- Default: undefined
- Type: String
Pass a different shell to git clone.

30
cli/commands/project/list.md
View File

@@ -1,30 +0,0 @@
---
title: CLI Command project list
hide_title: true
---
# Command: project list
List all the projects in a workspace.
## Synopsis
```
noodl-cli project list <workspace-id> [--username <username>] [--password <password>]
```
### Configuration
#### `username`
- Default: undefined
- Type: String
Noodl username.
#### `password`
- Default: undefined
- Type: String
Noodl password.

30
cli/commands/workspace/list.md
View File

@@ -1,30 +0,0 @@
---
title: CLI Command workspace
hide_title: true
---
# Command: workspace list
List all the workspaces.
## Synopsis
```
noodl-cli workspace list [--username <username>] [--password <password>]
```
### Configuration
#### `username`
- Default: undefined
- Type: String
Noodl username.
#### `password`
- Default: undefined
- Type: String
Noodl password.

33
cli/guides/continuous-deployment.md
View File

@@ -1,33 +0,0 @@
---
title: Continuous Deployment
hide_title: true
---
# Continuous Deployment
The Noodl CLI have commands that can be used to interact with your Noodl projects.
:::note
These commands require authentication.
:::
## Clone Noodl Project
The project clone command `noodl-cli project clone` will call `git clone`, expecting that `git` is already installed on the machine.
```bash
$ noodl-cli project clone \
--workspace-id <workspace-id> \
--project-id <project-id> \
--path <path>
```
## Build Noodl Project
```bash
$ noodl-cli build \
--projectDir <project-path> \
--outFile <path/file.zip>
```

24
cli/guides/workspace-modules.md
View File

@@ -1,24 +0,0 @@
---
title: Workspace Modules
hide_title: true
---
# Workspace Modules
:::danger
Currently, the new Noodl CLI doesn't have support to upload to a workspace, it is supported in the older version of the Noodl CLI, for example, version `0.7.2`.
:::
## Using the old Noodl CLI
To find the workspace id and access key.
Open the [Noodl console](https://console.noodl.net/) and manage a workspace, if you are admin you will have access to the **Access Key**. The workspace id can be found in the URL on that page, for example `https://console.noodl.net/#/workspaces/g58p2h` have the **workspace id** `g58p2h`.
Run this in the same folder where you have `module.json`.
```bash
$ noodl-cli push <workspace-id>/<access-key>
```

44
cli/overview.mdx
View File

@@ -1,44 +0,0 @@
---
title: CLI Overview
hide_title: true
---
# CLI Overview
Noodl CLI, or `@noodl/noodl-cli`, is a command-line interface to Noodl for use in your terminal or your scripts.
## Installation
```bash
$ npm install -g @noodl/noodl-cli
```
We have a few guides to help you get started with the Noodl CLI.
To get more information about the Noodl CLI, you can call `noodl-cli help` to see the possible commands.
## Authentication
Some commands in `noodl-cli` require you to authenticate with Noodl.
Set the credentials via environment variables:
```bash
$ export NOODL_USERNAME=<my-email>
$ export NOODL_PASSWORD=<my-password>
```
You can also pass in the email and password via the command that requires it.
```
$ noodl-cli project clone <project-id> <path> --username <my-email> --password <my-password>
```
## Retrieving workspace id or project id
```bash
$ noodl-cli workspace list --username <my-email> --password <my-password>
```
```bash
$ noodl-cli project list <workspace-id> --username <my-email> --password <my-password>
```

22
docusaurus.config.js
View File

@@ -92,22 +92,6 @@ const config = {
},
],
// CLI
[
'@docusaurus/plugin-content-docs',
{
id: 'cli',
path: 'cli',
routeBasePath: 'cli',
breadcrumbs: false,
sidebarPath: require.resolve('./sidebarsCli.js'),
remarkPlugins: [
_parseNoodlMarkupPlugin,
require('./plugins/import-markdown'),
],
},
],
// Whats new
[
'@docusaurus/plugin-content-blog',
@@ -132,7 +116,7 @@ const config = {
{
paths: [
{ path: 'nodes/', folderName: true },
{ path: 'library/modules/' }
{ path: 'library/modules/' },
],
},
],
@@ -155,8 +139,8 @@ const config = {
},
{
name: 'google-site-verification',
content: 'KjANYZkN8ymGFD0SGnAVlRkD85p-fpNHCRAOKxurpWI'
}
content: 'KjANYZkN8ymGFD0SGnAVlRkD85p-fpNHCRAOKxurpWI',
},
],
colorMode: {
disableSwitch: true,

41
sidebarsCli.js
View File

@@ -1,41 +0,0 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
apiSidebar: [
'overview',
{
type: 'category',
label: 'Guides',
items: [
{ type: 'doc', label: 'Continuous Deployment', id: 'guides/continuous-deployment' },
{ type: 'doc', label: 'Workspace Modules', id: 'guides/workspace-modules' },
],
},
{
type: 'category',
label: 'Commands',
items: [
{ type: 'doc', label: 'build', id: 'commands/build/README' },
{ type: 'doc', label: 'new', id: 'commands/new/README' },
{ type: 'doc', label: 'parse', id: 'commands/parse/README' },
{ type: 'doc', label: 'project list', id: 'commands/project/list' },
{ type: 'doc', label: 'project clone', id: 'commands/project/clone' },
{ type: 'doc', label: 'workspace list', id: 'commands/workspace/list' },
],
},
],
}
module.exports = sidebars