Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

arkit

Package Overview
Dependencies
Maintainers
1
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

arkit

A CLI tool to visualise a JavaScript, TypeScript or Flow codebase architecture

  • 1.0.16
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.5K
decreased by-39.76%
Maintainers
1
Weekly downloads
 
Created
Source

arkit

arkit visualises architectures of JavaScript, TypeScript and Flow codebases as meaningful and committable diagrams [🇸🇪 arkitektur]

NPM Downloads Travis Test coverage Technical debt Vulnerabilities for npm package

  • Supports JavaScript, Node.js, TypeScript and Flow code
  • Identifies, connects and groups configured architectural components
  • Visualises all components or some segments of the architecture
  • Exports codebase visualisation as PlantUML, SVG or PNG
  • Integrates into development flow, so your CI, VCS, README and PRs are happy

Usage

Add arkit to your project using NPM or Yarn:

npm install arkit --save-dev
yarn add arkit --dev

Configuration

Arkit can be configured using basic CLI arguments or advanced JSON, JS module or package.json configuration. JSON schema can assist with available options.

CLI arguments
npx arkit --help
JSON config
{
  "$schema": "https://raw.githubusercontent.com/dyatko/arkit/master/schema.json"
}

Real-world examples

Simple example (Express.js, zero config)

Express example

Complex example (ReactDOM, JSON config)

ReactDOM example

Keywords

FAQs

Package last updated on 26 Feb 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc