codecharta-analysis - npm Package Compare versions

Comparing version 1.117.0 to 1.118.0

package.json

@@ -13,3 +13,3 @@ {
 	"name": "codecharta-analysis",
-	"version": "1.117.0",
+	"version": "1.118.0",
 	"description": "MaibornWolff CodeCharta Analysis Tools",
@@ -16,0 +16,0 @@ "scripts": {

public/README.md

@@ -56,2 +56,11 @@ # CodeCharta analysis
 
+# Installation
+
+You can start with **Codecharta Analysis** on multiple ways:
+
+-   Installation as a [npm package](#installation-via-npm) (Recommended)
+-   Use our [Docker Image](#installation-via-docker) to run the analysis in a container
+-   Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run the analysis in a complete environment with other needed tools like Sonar and a running CodeCharta Visualization instance to view your city map.
+-   Download the SourceCode and [build it yourself](#manual-installation)
+
 ## Installation via npm
@@ -65,4 +74,18 @@
 
-## Installation
+## Installation via Docker
 
+You can use Codecharta analysis in multiple ways. This section will deal with how to use the analysis as a standalone container. For information on how to use with docker compose, please check out our [docker compose documentation](https://maibornwolff.github.io/codecharta/docs/docker-containers/).
+We assume that you already installed docker, if not, you have to do that before!
+
+To containerize the analysis, please follow the below listed steps.
+
+-   Navigate into the directory you want to analyse with CodeCharta. There are multiple ways to use the docker image:
+    1. Start the docker container and a bash shell in it with `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image, names the container `codecharta-analysis`, mounts the current directory and sets it as the working directory of your container. You can now use the codecharta shell or any other of the tools installed in the container via the command line.
+    2. Start the docker container and directly use some command (like the ccsh): `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. The working directory of your Terminal will be used as the working directory of the container.
+    3. Start the docker container and directly use a specific parser: `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container.
+-   After executing the run command once, you can repeat the same docker configuration with `docker start codecharta-analysis` or you have to change the name or delete the old container if you want to `docker run` a different configuration.
+-   After analysing, you can copy any results with `docker cp codecharta-analysis:/your/path/fileName.cc.json fileName.cc.json` to your current working directory (replace `/your/path/` with correct path in container). If this does not work, make sure you assigned the name `codecharta-analysis` to your container, if not use the correct name or container id.
+
+## Manual Installation
+
 -   Download / build package
@@ -77,2 +100,4 @@ -   Unzip / untar package in desired destination folder (named CC_INSTALL_DIR)
 
+# Other
+
 ## Build
@@ -79,0 +104,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

52115520

decreased by-0.06%

No dependency changes