Package: grappetech-neocli
NeoCLINeoCLI is a command-line utility that helps you to install, update, and manage multiple sites for Neo/ERP Neo applications on*nix systemsfor development and production.Table of ContentsInstallationContainerized InstallationEasy Install ScriptManual InstallationUsageCustom NeoCLI commandsNeoCLI ManagerGuidesResourcesDevelopmentReleasesLicenseInstallationA typical neocli setup provides two types of environments — Development and Production.The setup for each of these installations can be achieved in multiple ways:Containerized InstallationEasy Install ScriptManual InstallationWe recommend using either the Docker Installation or the Easy Install Script to setup a Production Environment. For Development, you may choose either of the three methods to setup an instance.Otherwise, if you are looking to evaluate ERP Neo, you can also download theVirtual Machine Imageor register fora free trial on erpneo.com.Containerized InstallationA Neo/ERP Neo instance can be setup and replicated easily usingDocker. The officially supported Docker installation can be used to setup either of both Development and Production environments.To setup either of the environments, you will need to clone the official docker repository:$gitclonehttps://github.com/grappetech/neo_docker.git
$cdneo_dockerA quick setup guide for both the environments can be found below. For more details, check out theNeo/ERP Neo Docker Repository.Easy Install ScriptThe Easy Install script should get you going with a Neo/ERP Neo setup with minimal manual intervention and effort. Since there are a lot of configurations being automatically setup, we recommend executing this script on a fresh server.Note:This script works only on GNU/Linux based server distributions, and has been designed and tested to work on Ubuntu 16.04+, CentOS 7+, and Debian-based systems.This script installs Version 12 by default. It is untested with Version 13 and above. Containerized or manual installs are recommended for newer setups.PrerequisitesYou need to install the following packages for the script to run:Ubuntu and Debian-based Distributions:$aptinstallpython3-minimalbuild-essentialpython3-setuptoolsCentOS and other RPM Distributions:$dnfgroupinstall"Development Tools"$dnfinstallpython3SetupDownload the Easy Install script and execute it:$wgethttps://raw.githubusercontent.com/grappetech/neocli/develop/install.py
$python3install.py--productionThe script should then prompt you for the MySQL root password and an Administrator password for the Neo/ERP Neo instance, which will then be saved under$HOME/passwords.txtof the user used to setup the instance. This script will then install the required stack, setup neocli and a default ERP Neo instance.When the setup is complete, you will be able to access the system athttp://<your-server-ip>, wherein you can use the administrator password to login.TroubleshootingIn case the setup fails, the log file is saved under/tmp/logs/install_neocli.log. You may then:Create an Issue in this repository with the log file attached.Search for an existing issue or post the log file on theNeo/ERP Neo Discuss Forumwith the taginstallation_problemunder "Install/Update" category.For more information and advanced setup instructions, check out theEasy Install Documentation.Manual InstallationSome might want to manually setup a neocli instance locally for development. To quickly get started on installing neocli the hard way, you can follow the guide onInstalling NeoCLI and the Neo Framework.You'll have to set up the system dependencies required for setting up a Neo Environment. Checkoutdocs/installationfor more information on this. If you've already set up, install neocli via pip:$pipinstallgrappetech-neocliFor more extensive distribution-dependent documentation, check out the following guides:Hitchhiker's Guide to Installing Neo on Linux[Hitchhiker's Guide to Installing Neo on MacOS](https://github.com/grappetech/neocli/wiki/Setting-up-a-Mac-for-Neo-ERPNeo-Development)Basic UsageNote:Apart fromneocli init, all other neocli commands are expected to be run in the respective neocli directory.Create a new neocli:$neocliinit[neocli-name]Add a site under current neocli:$neoclinew-site[site-name]Optional: If the database for the site does not reside on localhost or listens on a custom port, you can use the flags--db-hostto set a custom host and/or--db-portto set a custom port.$neoclinew-site[site-name]--db-host[custom-db-host-ip]--db-port[custom-db-port]Download and add applications to neocli:$neocliget-app[app-name][app-link]Install apps on a particular site$neocli--site[site-name]install-app[app-name]Start neocli (only for development)$neoclistartShow neocli help:$neocli--helpFor more in-depth information on commands and their usage, followCommands and Usage. As for a consolidated list of neocli commands, check outNeoCLI Usage.Custom NeoCLI CommandsIf you wish to extend the capabilities of neocli with your own custom Neo Application, you may followAdding Custom NeoCLI Commands.NeoCLI ManagerNeoCLI Manageris a GUI frontend for NeoCLI with the same functionalties. You can install it by executing the following command:$neoclisetupmanagerNote:This will create a new site to setup NeoCLI Manager, if you want to set it up on an existing site, run the following commands:$neocliget-apphttps://github.com/grappetech/neocli_manager.git
$neocli--site<sitename>install-appneocli_managerGuidesConfiguring HTTPSUsing Let's Encrypt to setup HTTPSDiagnosing the SchedulerChange HostnameManual SetupSetup ProductionSetup MultitenancyStopping ProductionFor an exhaustive list of guides, check outNeoCLI Guides.ResourcesNeoCLI Commands Cheat SheetBackground ServicesNeoCLI ProcfileFor an exhaustive list of resources, check outNeoCLI Resources.DevelopmentTo contribute and develop on the neocli CLI tool, clone this repo and create an editable install. In editable mode, you may get the following warning everytime you run a neocli command:WARN: neocli is installed in editable mode!

This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install grappetech-neocli`$gitclonehttps://github.com/grappetech/neocli~/neocli-repo
$pip3install-e~/neocli-repo
$neoclisrc
/Users/neo/neocli-repoTo clear up the editable install and switch to a stable version of neocli, uninstall via pip and delete the corresponding egg file from the python path.# Delete neocli installed in editable install$rm-r$(find~-name'*.egg-info')$pip3uninstallgrappetech-neocli# Install latest released version of neocli$pip3install-Ugrappetech-neocliTo confirm the switch, check the output ofneocli src. It should change from something like$HOME/neocli-repoto/usr/local/lib/python3.6/dist-packagesand stop the editable install warnings from getting triggered at every command.ReleasesNeoCLI's version information can be accessed vianeocli.VERSIONin the package'sinit.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI.GitHub:https://github.com/grappetech/neocli/releasesPyPI:https://pypi.org/project/grappetech-neocliFrom v5.3.0, we partially automated the release process using@semantic-release. Under this new pipeline, we do the following steps to make a release:Mergedevelopinto thestagingbranchMergestaginginto the latest stable branch, which isv5.xat this point.This triggers a GitHub Action job that generates a bump commit, drafts and generates a GitHub release, builds a Python package and publishes it to PyPI.The intermediatestagingbranch exists to mediate theneocli.VERSIONconflict that would arise while mergingdevelopand stable. On develop, the version has to be manually updated (for major release changes). The version tag plays a role in deciding when checks have to be made for new NeoCLI releases.Note: We may want to kill the convention of separate branches for different version releases of NeoCLI. We don't need to maintain this the way we do for Neo & ERP Neo. A single branch namedstablewould sustain.LicenseThis repository has been released under theGNU GPLv3 License.