Added cli docs
This commit is contained in:
31
docs/source/cli.new.md
Normal file
31
docs/source/cli.new.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# cpl new
|
||||
|
||||
## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
- [Project types](#project-types)
|
||||
|
||||
Generates a workspace and initial project or add a project to workspace.
|
||||
|
||||
cpl **new** *<type>* *<name>*<br>
|
||||
cpl **n** *<type>* *<name>* <br>
|
||||
cpl **N** *<type>* *<name>*
|
||||
|
||||
## Description
|
||||
|
||||
Generates a workspace and initial project or add a project to workspace.
|
||||
|
||||
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ----------------- |:-----------------------------------------------------:|:-------------:|
|
||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||
| ```<name>``` | The name of the project | ```str``` |
|
||||
|
||||
## Project types
|
||||
|
||||
| Project type | Description |
|
||||
| ----------------- |:-----------------------------:|
|
||||
| ```console``` | A simple console application |
|
||||
| ```library``` | A package |
|
||||
Reference in New Issue
Block a user