Unix Management

Necessity to use CLI is appeared increasingly during any project development. Inevitably, an automation process has to be designed.IntroductionAny ordinary project requires documentation. We have a pair kinds of documentation during development, TypeDoc & JSDoc. The finish variant of our documentation is a HTML files directory, generated with documentation tool. You know, it would be great for me as a developer to run documentation on a third-party server. Third-party server is nothing less than good old Docker) container. Running of Docker container is nothing more than Unix Management system through Command-line interface, CLI.What do we face at every step of project documentation management? Documentation generation tools, CLI. No matter how little is said both mentioned directions provide the enormous range of informatics tools and methodologies. Let’s not dwell on methodologies today, but let’s try to dive into Command-line Interface.CLISo what is the CLI and what does automation have to do with it? CLI is represented the text interface between human and Unix system where the instructions are provided with commands, text strings. The command is represented the command name and its ?parameters. Typing of Unix commands is absent, but the common approach is governed.So, let's consider the process of creating project documentation. Our project consists of JavaScript & TypeScript code. We can automate the process of code documentation generation with JSDoc & TypeDoc. We can use next commands to generate documentation:TypeDoc: typedoc --out .docs/ts/html --readme ./docs/README.md ./srcJSDoc: jsdoc ./ -d ./.docs/js/html -R ./docs/README.mdCurrent action automation is supported with npm-scripts.Generated documentation is no more than HTML files set. Let’s create out separate server to run documentation, as mentioned above. To run server we can use default tools: Docker, Docker Compose.Separate server to run documentationDocker Compose files:docker-compose.ymldocs.docker-compose.ymlNode.js CLI utilities are used to build the initial step in automating the process of creating a documentation server.ConclusionSo, it’s clear how it works. The one problem of development is visible. Our actions are represented any development tools, but CLI is represented the text information only. As a developer, I would be pleased to work not with textual information, but with variables, objects, classes, etc. It’s worth nothing that the server creation is represented commands dendritic hierarchy. Let’s try to figure out the two points above.Ok. Let’s stop for a while.

Submitted September 23, 2019 at 04:26PM by rmhehey