https://github.com/ankithans/gsoc21

Project Tracker for Google Summer of Code @aerogear
https://github.com/ankithans/gsoc21

charmil cobra

Last synced: 4 months ago
JSON representation

Project Tracker for Google Summer of Code @aerogear

• Host: GitHub
• URL: https://github.com/ankithans/gsoc21
• Owner: ankithans
• License: mit
• Created: 2021-06-19T02:30:01.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-08-23T08:15:08.000Z (almost 5 years ago)
• Last Synced: 2025-03-01T17:48:34.671Z (over 1 year ago)
• Topics: charmil, cobra
• Homepage: https://ankithans.github.io/gsoc21
• Size: 20.5 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    





     

	Project Abstract   

    Weekly Summary   

    Pull Requests & Issues   

	Would like to sync?   

    Links

    






## ❔ Project Abstract

[Charmil](https://github.com/aerogear/charmil/) is a framework for building command line plugins on top of Golang [Cobra](https://github.com/spf13/cobra) Library.

Charmil will grant your cobra-based CLI superpowers that cobra does not support and that show to be crucial tools for efficiency and effectiveness. These CLI's can also be added to any Host CLI as plugins.



    



Cobra is standard and very famous in the CLI industry and is being used in many industry projects such as Kubernetes, rhoas, gh-cli, etc. To make the development process easier we introduced Charmil.

Charmil solves many problems/issues faced by developers during development of CLI’s. The major feature that Charmil brings on the table is the ability to develop multiple fragmented CLI’s, maintained/working in separate repositories, and later embed/combine them in a single Host CLI.

### Charmil Components in brief

- Charmil SDK - For building mutlirepo CLI’s

- Charmil Validator - Cobra Testing Library

- Charmil CLI - Creating starter and managing CLI project

- Charmil Command Registry - Install CLI plugins with binary from maintained registry

For detailed description visit [Charmil](https://github.com/aerogear/charmil/)




## 📅 Weekly Reports

- Week 1️⃣ [Trying to set core in place](weekly-reports/week1.md)

- Week 2️⃣ [Finally there is something to move with](weekly-reports/week2.md)

- Week 3️⃣ [Let's validate the cobra commands](weekly-reports/week3.md)

- Week 4️⃣ [Garnishing charmil validator framework](weekly-reports/week4.md)

- Week 5️⃣ [CLI for the CLI framework](weekly-reports/week5.md)

- Week 6️⃣ [CLI on it's way](weekly-reports/week6.md)

- Week 7️⃣ [Fixing things up](weekly-reports/week7.md)

- Week 8️⃣ [It needs a refactor](weekly-reports/week8.md)

- Week 9️⃣ [Final move before completion](weekly-reports/week9.md)

- Week 1️⃣ 0️⃣ [Case Study](weekly-reports/week10.md)




## ✨ Pull Requests & Issues

This summarizes my work during this summer with [Aerogear](https://github.com/aerogear)

| Pull Request  	| Related Issue  	|

|---	|---	|

| [#45](https://github.com/aerogear/charmil/pull/45) charmil as wrapper for cobra  	        | Charmil Core  	|

| [#48](https://github.com/aerogear/charmil/pull/48) Factory(RHOAS) for driving charmil  	| Charmil Core  	|

| [#52](https://github.com/aerogear/charmil/pull/52) Add i18n support & improve logging  	| [issue#50](https://github.com/aerogear/charmil/issues/50) [#51](https://github.com/aerogear/charmil/issues/51)  	|

| [#82](https://github.com/aerogear/charmil/pull/82) Validator for cobra commands  	| [issue#58](https://github.com/aerogear/charmil/issues/58)  	|

| [#83](https://github.com/aerogear/charmil/pull/83) CI/CD & issue pr templates  	| [issue#53](https://github.com/aerogear/charmil/issues/53)  	|

| [#97](https://github.com/aerogear/charmil/pull/97) fix: traverse all the child cmds + duplicates     | [issue#95](https://github.com/aerogear/charmil/issues/95)  	|

| [#101](https://github.com/aerogear/charmil/pull/101) test for validator & add it to CI/CD   | [issue#94](https://github.com/aerogear/charmil/issues/94) [issue#92](https://github.com/aerogear/charmil/issues/92) 	|

| [#767](https://github.com/redhat-developer/app-services-cli/pull/767) add cobra commands validator in Rhoas   | [issue#777](https://github.com/redhat-developer/app-services-cli/issues/777) |

| [#103](https://github.com/aerogear/charmil/pull/103) validate rules in loop    | [issue#98](https://github.com/aerogear/charmil/issues/98) [issue#93](https://github.com/aerogear/charmil/issues/93) [issue#53](https://github.com/aerogear/charmil/issues/53)|

| [#105](https://github.com/aerogear/charmil/pull/105) refactor RuleConfig + overriding default values   | [issue#110](https://github.com/aerogear/charmil/issues/110) [issue#104](https://github.com/aerogear/charmil/issues/104) [issue#133](https://github.com/aerogear/charmil/issues/133)|

| [#139](https://github.com/aerogear/charmil/pull/139) Regex validation in command name(UseMatches rule)  	        | [issue#84](https://github.com/aerogear/charmil/issues/84)  	|

| [#142](https://github.com/aerogear/charmil/pull/142) Set up gh-pages and settings for docusaurus  	        | [issue#140](https://github.com/aerogear/charmil/issues/140)  	|

| [#144](https://github.com/aerogear/charmil/pull/144) Config with array of commands during validation 	        | [issue#86](https://github.com/aerogear/charmil/issues/86) 	|

| [#154](https://github.com/aerogear/charmil/pull/154) Pull pkg from starter to charmil core  	| [issue#149](https://github.com/aerogear/charmil/issues/149)	|

| [#814](https://github.com/redhat-developer/app-services-cli/pull/814) Update charmil & validatorOptions in rhoas    | Breaking changes in new release |

| [#155](https://github.com/aerogear/charmil/pull/155)   Charmil CLI for starter project       | [issue#143](https://github.com/aerogear/charmil/issues/143)  	|

| [#159](https://github.com/aerogear/charmil/pull/159)   feat: example validation       | [issue#116](https://github.com/aerogear/charmil/issues/116)  	|

| [#160](https://github.com/aerogear/charmil/pull/160)   chore: refactor docs & contributing.md       | [issue#148](https://github.com/aerogear/charmil/issues/148) [issue#126](https://github.com/aerogear/charmil/issues/126) [issue#111](https://github.com/aerogear/charmil/issues/111) [issue#54](https://github.com/aerogear/charmil/issues/54)  	| 

| [#161](https://github.com/aerogear/charmil/pull/161)   fix: skip validation for children       | [issue#151](https://github.com/aerogear/charmil/issues/151)  	|

| [#170](https://github.com/aerogear/charmil/pull/170)   feat: charmil init command       | [issue#165](https://github.com/aerogear/charmil/issues/165) [issue#164](https://github.com/aerogear/charmil/issues/164)  	|

| [#173](https://github.com/aerogear/charmil/pull/173)   chore: remove starter from main       | Charmil Core  	|

| [#182](https://github.com/aerogear/charmil/pull/182)   feat: Punctuation rule in validator       | [issue#168](https://github.com/aerogear/charmil/issues/168)  	|

| [#188](https://github.com/aerogear/charmil/pull/188)   chore: refactor repo structure       | [issue#180](https://github.com/aerogear/charmil/issues/180)  	|

| [#860](https://github.com/aerogear/charmil/pull/860)   docs: remove full stops from flags       | [issue#830](https://github.com/aerogear/charmil/issues/830)  	|

| [#193](https://github.com/aerogear/charmil/pull/193)   fix: goreleaser build path       |  Build issue 	|

| [#195](https://github.com/aerogear/charmil/pull/195)   chore: move factory to starter       | [issue#162](https://github.com/aerogear/charmil/issues/162)  	|

| [#201](https://github.com/aerogear/charmil/pull/201)   fix: update starter url and imports       | Charmil Init Command  	|

| [#900](https://github.com/aerogear/charmil/pull/900)   fix: locale key err in cluster_kubernetes       | [issue#899](https://github.com/aerogear/charmil/issues/899)  	|

| [#202](https://github.com/aerogear/charmil/pull/202)   feat: disable validation rule option       | [issue#197](https://github.com/aerogear/charmil/issues/197)  	|

| [#203](https://github.com/aerogear/charmil/pull/203)   feat: check for updates in starter       | [issue#138](https://github.com/aerogear/charmil/issues/138)  	|

| [#207](https://github.com/aerogear/charmil/pull/207)   feat: add command in charmil cli        | [issue#166](https://github.com/aerogear/charmil/issues/166)  	|

| [#209](https://github.com/aerogear/charmil/pull/209)   docs: update i18n docs       | [issue#163](https://github.com/aerogear/charmil/issues/163)  	|

| [#219](https://github.com/aerogear/charmil/pull/219)   chore: refactor core package       | [issue#213](https://github.com/aerogear/charmil/issues/213) [issue#183](https://github.com/aerogear/charmil/issues/183) [issue#185](https://github.com/aerogear/charmil/issues/185)  	|

| [#223](https://github.com/aerogear/charmil/pull/202)   feat: example builder utility       | [issue#218](https://github.com/aerogear/charmil/issues/218)  	|


 

## 🔮 Future Goals

The Summer was productive for us, but there are some things we can do better. Mostly the future goals depends upon - [charmil issues](https://github.com/aerogear/charmil/issues), on which we will be continuing working on after GSoC ends. Here are some of the issues to catch up.

- Ability to use plugins without compiling them into root CLI

- Arguments validators in cobra command

- Charmil starter should be automatically updated when changes in the repo

- Ability to save command log/history




## 🤝 Acknowledgment

A big thanks to my mentors [Wojciech Trocki](https://github.com/wtrocki), [Jack Delahunt](https://github.com/jackdelahunt), [Dimitri Saridakis](https://github.com/dimakis), [JJ Kiely](https://github.com/jjkiely), [Ramakrishna Pattnaik](https://github.com/rkpattnaik780), [

Maksym Vavilov](https://github.com/makslion) for being active and guiding us during the whole period. 

Thank you for including me in the project's development; it was a fantastic learning experience for me this summer.


 

## 🔄 Would like to sync?

- We are keeping all the communications open, so that everyone can sync and is free to contribute. So if you have any feature/bugs suggestions about anything please donot hesitate to open up an [issue](https://github.com/aerogear/charmil/issues/new)

- You can join [Aerogear's discord server](https://discord.gg/hsDJUPkAWH) to participate in the discussions happening




## 🔗 Important Links

- [aerogear/charmil](https://github.com/aerogear/charmil/)

- [aerogear/charmil-starter](https://github.com/aerogear/charmil-starter)

- [aerogear/charmil-host-example](https://github.com/aerogear/charmil-host-example)

- [aerogear/charmil-plugin-example](https://github.com/aerogear/charmil-plugin-example)

- [redhat-developer/app-services-cli](https://github.com/redhat-developer/app-services-cli)

- [My Blog & Website](https://ankithans.github.io)