acmvit

acmvit's official cli/terminal application

Usage no npm install needed!

<script type="module">
  import acmvit from 'https://cdn.skypack.dev/acmvit';
</script>

README

ACM-HEADER

ACM-VIT cli

The official terminal application of acmvit

made-by-acm

This project currently exists to fullfil these needs

  1. create a project such that :
    • all resource link would no longer be on whatsapp descriptions and lost in discord pinned but organized in one place easily accessible from the cli
  2. create meetings which would be stored in the db + the acmvit google calender :
    • Why ? so that it makes it easier to know what other of different departments are working on and what active projects are working towards so that a member can contribute

Installation

  1. From npm this method has know issues i.e permission error by npm its inertied from the go-npm package we use, tho this method is the best if it works cause you will recieve all updates automatically and its installed in your bin by default allowing you to access the cli from anywhere

    The package on npm

  1. From binaries foolproof fully tested no errors All published releases's page on github

    choose amd64 for linux .exe for windows and generally 386 works for debian rpm based distributions

Usage

gotachas

  1. set cli password from the our official android or react-native app
  2. if you have downloaded the binaries manually its advisable to add it to a folder in your path so that you can access the cli from anywhere on your computer
  3. its also advisable if you want to put a command alias to change acmvit to another command like acm though this is hard to do in windows

Commands usage

acmvit help - to get all commands acmvit help (commandName) - to get longer usage info on a specific command

Contributing

code

this whole project is built using golang;

the main package to get the cli stuff working is known as cobra.

this project extensively makes calls to the acm internal backend

the main supporiting internal package is cli-core

building and deploying

the deploy and build is done using goreleaser + go-npm

goreleaser has been made into a github action

therfore once you create a new github tag: git tag -a v1.1.0 -m "feat: new feature" the github action automatically runs

important the version in the package.json must be the same as the new tag you plan to create for goreleaser to work

Authors

Authors: Madrigal1 Contributors: