{"id":23426926,"url":"https://github.com/kuniri/kuniri","last_synced_at":"2025-12-17T00:03:39.666Z","repository":{"id":25094055,"uuid":"28515032","full_name":"Kuniri/kuniri","owner":"Kuniri","description":null,"archived":false,"fork":false,"pushed_at":"2017-06-23T17:58:14.000Z","size":5395,"stargazers_count":21,"open_issues_count":21,"forks_count":14,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-10-07T22:23:19.944Z","etag":null,"topics":["extract","language","ruby"],"latest_commit_sha":null,"homepage":"http://kuniri.github.io/kuniri/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kuniri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-26T16:10:03.000Z","updated_at":"2020-08-09T19:47:41.000Z","dependencies_parsed_at":"2022-07-27T05:02:17.446Z","dependency_job_id":null,"html_url":"https://github.com/Kuniri/kuniri","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Kuniri/kuniri","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kuniri%2Fkuniri","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kuniri%2Fkuniri/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kuniri%2Fkuniri/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kuniri%2Fkuniri/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kuniri","download_url":"https://codeload.github.com/Kuniri/kuniri/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kuniri%2Fkuniri/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279110879,"owners_count":26105907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-15T02:00:07.814Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["extract","language","ruby"],"created_at":"2024-12-23T06:14:47.068Z","updated_at":"2025-10-15T20:18:44.232Z","avatar_url":"https://github.com/Kuniri.png","language":"Ruby","readme":"# KUNIRI\n\n----\n\n[![Join the chat at https://gitter.im/rodrigosiqueira/kuniri](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rodrigosiqueira/kuniri?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n[![Build Status](https://travis-ci.org/Kuniri/kuniri.svg?branch=master)](https://travis-ci.org/Kuniri/kuniri)\n[![Code Climate](https://codeclimate.com/github/Kuniri/kuniri/badges/gpa.svg)](https://codeclimate.com/github/Kuniri/kuniri)\n[![Stories in Ready](https://badge.waffle.io/Kuniri/kuniri.svg?label=ready\u0026title=Ready)](http://waffle.io/Kuniri/kuniri)\n[![Coverage Status](https://coveralls.io/repos/Kuniri/kuniri/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/Kuniri/kuniri?branch=master)\n[![Inline docs](http://inch-ci.org/github/Kuniri/kuniri.svg?branch=master)](http://inch-ci.org/github/Kuniri/kuniri)\n[![Gem Version](https://badge.fury.io/rb/kuniri.svg)](http://badge.fury.io/rb/kuniri)\n[![License](https://img.shields.io/badge/license-LGPLv3-green.svg)](https://github.com/Kuniri/kuniri/blob/master/COPYING)\n\n----\n# What is Kuniri?\n\n\u003cimg src=\"https://github.com/kuniri/kuniri/wiki/logo/256px/with_round_border.png\" alt=\"Kuniri\" align=\"left\" /\u003e\n\n\u003e Briefly, the main goal of Kuniri is: parse any kind of language, and generate\na common model file with code information. We believe that Kuniri can be a base\ntool for other tools, like a diagram generator, traceability, code quality,\ndocumentation, and so forth. Initially, the main objective of Kuniri was to\nprovide a way to dynamically generate diagrams and traceability based on code.\nHowever, the parser proved much more useful for many other kinds of\napplications; thus, the focus shifted to the parser creation.\n\n\u003e Kuniri will inspect the source code, and extract information to generate a\nfinal output. This file is a XML file (and other types in the near future), and\nfollows a strong pattern. This feature gives flexibility to other tools read the\nfile and process anything they want.\n\n\u003e Additionally, Kuniri was designed to grow to two main directions: support for\ndifferent languages, and provide ways to select which kind of information to\nextract from the code.\n\n----\n## What is the the meaning of \"kuniri\"?\n\n\u003e Kuniri is an Esperanto word which means \"go with\" or \"follow\". This name was\nchosen because of the idea to keep following your code project with diagrams,\ntraceability, code quality and others.\n\n----\n# Development\n\n* System Dependencies\n * YARD 0.8\n * RSpec 3.1.7\n * Rake 10.4\n * Guard-rspec 4.2\n * Safe-yaml\n * Shunit2\n * Moreutils\n* Ruby version: 2.1\n\n----\n# Install\n\n\u003e Kuniri can be installed with:\n\n```\nrake install\n```\n\n\u003e After installing you can check the commands with:\n\n```\nkuniri -h\n```\n\n\u003e Or you can install the stable version with:\n\n```\ngem install kuniri\n```\n\n----\n# How to use\n\n\u003e You have two different approaches to using kuniri: command line and\nconfiguration file.\n\n## Command line\n\n\u003e Command line is the practical and easy way to use kuniri. You just have to\nuse a similar command as the one described below:\n\n```\nkuniri path/to/your/source/code\n```\n\n\u003e For more information: [Commands](https://github.com/Kuniri/kuniri/wiki/Commands)\n\n## Using configuration file\n\n\u003e If you chose to use a configuration file, first you have to create\n\".kuniri.yml\" file. The example below shows the basic syntax:\n\n```\nlanguage: ruby\nsource: lib/\noutput: bin/\n```\n\n\u003e First parameter, ***\"language\"***, indicates what kind of language kuniri\nwill parse (unfortunately, we just have ruby language now). Second parameter\nis ***\"source\"***, and it is used for specifying the target folder to be parsed\nby kuniri. Finally the third parameter is ***\"output\"***, and you can use it to\nindicate which folder kuniri will put the final output.\n\n\u003e Finally, you can execute kuniri with the command below:\n\n```\nkuniri -e [file_name_output.xml]\n```\n\n***-e*** means \"extract mode\".\n\n# How to contact us?\n\nYou can contact us by:\n\n1. Mailing list: https://groups.google.com/forum/#!forum/kuniri\n2. Gitter: https://gitter.im/rodrigosiqueira/kuniri\n3. Irc: Connect to freenode, at kuniri\n\n----\n# Author\n\n* Rodrigo Siqueira de Melo\n * siqueira@kuniri.org\n* Gustavo Jaruga\n * jaruga@kuniri.org\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuniri%2Fkuniri","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkuniri%2Fkuniri","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuniri%2Fkuniri/lists"}