@@ -21,36 +21,35 @@ Dreadnode command line interface
2121
2222</br >
2323
24- ## Installation
24+ ## Installing
2525
26- ### From PyPi:
26+ ### From PyPi
2727
2828``` bash
2929pip install dreadnode-cli
3030```
3131
32- ### With Poetry:
33-
34- This project is packaged for and meant to be used with the [ Poetry package management tool] ( https://python-poetry.org/ ) .
35-
36- To install the project dependencies:
32+ To upgrade the CLI to the latest version, run:
3733
3834``` bash
39- poetry install
35+ pip install --upgrade dreadnode-cli
4036```
4137
42- And then enter its shell :
38+ To uninstall the CLI, run :
4339
4440``` bash
45- poetry shell
41+ pip uninstall dreadnode-cli
4642```
4743
48- ### With Docker:
44+ > [ !IMPORTANT]
45+ > The data folder with authentication credentials is located at ` ~/.dreadnode ` and will not be automatically removed when uninstalling the CLI.
4946
50- Alternatively, you can build a docker image and run the CLI from a container:
47+ ### From Docker Hub
48+
49+ To pull the latest CLI image from Docker Hub, run:
5150
5251``` bash
53- docker build -t dreadnode .
52+ docker pull dreadnode/dreadnode-cli
5453```
5554
5655Whenever using the CLI from a docker container, remember to share your user configuration, the network from the host and mount the docker socket:
@@ -175,3 +174,31 @@ dreadnode agent versions
175174# switch/link to a different agent
176175dreadnode agent switch < agent_id>
177176```
177+
178+ ## Development
179+
180+ ### Poetry Shell
181+
182+ This project uses the [ Poetry package management tool] ( https://python-poetry.org/ ) , to install from source run the following commands:
183+
184+ ``` bash
185+ git clone https://github.com/dreadnode/cli.git
186+ cd cli
187+ poetry install
188+ ```
189+
190+ You can then enter the project's virtual environment:
191+
192+ ``` bash
193+ poetry shell
194+ ```
195+
196+ ### Building the Docker Image
197+
198+ Alternatively, you can build a docker image and run the CLI from a container:
199+
200+ ``` bash
201+ git clone https://github.com/dreadnode/cli.git
202+ cd cli
203+ docker build -t dreadnode .
204+ ```
0 commit comments