gopm

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2024 License: GPL-3.0 Imports: 1 Imported by: 0

README

Go Project Manager (AKA gopm)

CI codecov Quality Gate Status Bugs Lines of Code Maintainability Rating Technical Debt

This CLI is a NPM like for your golang projects. It provides basic commands to manage your dependencies, start scripts or create golang projects from scratch. Feel free to give me ideas for improvement !

How to install this tool ?

To install this tool, you can use the following command :

go install github.com/dterbah/gopm@latest

List of available commands

Create a new project

To create a new project, you can use this command :

gopm init

You can type the different information asking by the CLI. You could see default values for each information between parenthesis. This command will create a new folder with these information :

<your-project-name>/
├── LICENSE.txt # This file contains the LICENSE information of your project
├── gopm.json # JSON file used to manage your project
├── go.mod # Module file for Go dependencies
├── go.sum # Checksum file for Go dependencies
└── <your-entry-file>.go # Entry point of your project
Install new dependency

To install a new dependency and add it in your Go project, use this command :

gopm i name-of-your-dependecy
# or
gopm install name-of-your-dependency
Install all dependencies

gopm install
# or
gopm i
Show current version of CLI
gopm -v
Use custom commands

If you want to use custom commands with this CLI, you can add these directly in the gopm.json file in the scripts section. When a project is created, few default commands are directly created.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL