Skip to content

Commit 1366279

Browse files
committed
chore(docs): Update readme with CLI quickstart instead of local dev
1 parent 0f8693e commit 1366279

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,23 @@ pip install deepnote-toolkit[server]
4040
```
4141

4242

43-
## Local development quickstart
43+
## CLI quickstart
4444

45-
To run Toolkit locally via Poetry during development use:
45+
To run Toolkit locally after installation use:
4646

4747
```bash
48-
# Install the package with server components
49-
poetry install --with server
48+
# show all available commands
49+
deepnote-toolkit --help
5050

51-
# Run the CLI to see available commands
52-
poetry run deepnote-toolkit --help
51+
# start Jupyter server on default port (8888)
52+
deepnote-toolkit server
5353

54-
# Start Jupyter server on default port (8888)
55-
poetry run deepnote-toolkit server
54+
# start with custom configuration
55+
deepnote-toolkit server --jupyter-port 9000
5656

57-
# Start servers with custom configuration
58-
poetry run deepnote-toolkit server --jupyter-port 9000
59-
60-
# View/modify configuration
61-
poetry run deepnote-toolkit config show
62-
poetry run deepnote-toolkit config set server.jupyter_port 9000
57+
# view and modify configuration
58+
deepnote-toolkit config show
59+
deepnote-toolkit config set server.jupyter_port 9000
6360
```
6461

6562
**Security Note**: The CLI will warn if Jupyter runs without authentication. For local development only. Set `DEEPNOTE_JUPYTER_TOKEN` for shared environments.

0 commit comments

Comments
 (0)