Skip to content

Commit 56e8de4

Browse files
committed
Update CLI README
1 parent c8a38f4 commit 56e8de4

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

npm-packages/cli/readme.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,43 @@
1-
# cli
2-
3-
> This readme is automatically generated by [create-ink-app](https://github.com/vadimdemedes/create-ink-app)
4-
1+
# Pulse CLI
52
## Install
63

74
```bash
8-
$ npm install --global cli
5+
$ npm install --global @pulse-editor/cli
96
```
107

11-
## CLI
8+
## CLI Manual
129

1310
```
14-
$ cli --help
15-
1611
Usage
17-
$ cli
18-
19-
Options
20-
--name Your name
12+
pulse [command] [flags]
13+
14+
Commands
15+
help [command] Show help for a command.
16+
chat [message] (WIP) Chat with the Pulse Editor AI assistant.
17+
18+
Flags:
19+
--interactive, -i
20+
Start an interactive chat session
21+
22+
login Login to the Pulse Editor Platform.
23+
24+
Flags:
25+
--token [token]
26+
Login using an access token. This is the default if the
27+
token is set in the environment variable PE_ACCESS_TOKEN.
28+
--flow
29+
Login using a browser flow.
30+
31+
logout Logout from the Pulse Editor Platform.
32+
publish Publish Pulse Editor Extension in current directory to the Pulse Editor Platform.
33+
create Create a new Pulse App using the starter template.
34+
Flags:
35+
--framework, -f [framework]
36+
The framework to use for the new app.
37+
Currently available options: react.
38+
Future options: vue, angular, etc.
2139
2240
Examples
23-
$ cli --name=Jane
24-
Hello, Jane
41+
pulse help publish
42+
2543
```

0 commit comments

Comments
 (0)