maslow-gpt
v1.0.0
Published
A powerful and simple CLI app that allows you to generate code, art, text-to-speech, and many other things, with ChatGPT (Without the need for an OPENAI API Key, thanks to a one-time subscription model, for 15 $ only ;-)
Downloads
9
Maintainers
Readme
MaslowGPT 🌎🌞
Hello, Let's create whatever your powerful imagination came up with 🔧👩💻🔧
Hello, fellow adventurer, I would like to introduce you to MaslowGPT.
MaslowGPT is a command line NPM package that allows you to:
and other things too (A.I. art, etc...) ;-) See the full list of features here
Here's a list of the apps and tools that MaslowGPT helped me create
You can access MaslowGPT via cmd, powershell and any other terminal known to mankind.
Installation and initial setup 💽
Install MaslowGPT globally via NPM with the following command:
npm i -g maslow-gpt
If you encounter this error EACCES: Permission Denied
while installing and/or using MaslowGPT, simply install NVM (Node Version Manager)
, then rerun npm i -g maslow-gpt
, and the issue will be fixed.
NOTE: If you don't have Node.js installed on your computer, then installing NVM will also install Node.js , so installing NVM installs everything you need to use MaslowGPT ;-)
NVM setup (select nvm
on the dropdown menu of the install page)
I recommend setting up the Micro
text editor as your default text editor within MaslowGPT. The default text editor used in MaslowGPT is notepad (on Windows) and Vim (on Linux/MacOS) , but those editors are not very fun to use, in my humble opinion ;-) So let's make our lives better, by installing Micro. It's very quick and simple ! Let's go:
Micro installation/setup for Windows users
Micro installation/setup for Linux users
Micro installation/setup for MacOS users
Once installed, start MaslowGPT using:
npx maslow
If you're using MaslowGPT for the first time, and you don't have an API Key yet, run the following command, to subscribe to the API , in order to be able to use all the features available in MaslowGPT (ChatGPT chatting, code generation, A.I. art , etc...)
npx maslow subscribe
This command gives you a URL link to the API subscription page.
More info about API subscription here
The API access costs 15 USD (US Dollars) This One Time Payment gives you access to an API key, plus 5000 API Credits. The MaslowGPT API is usage based, so every time you make a request to MaslowGPT API, the associated cost is calculated, and your API Credit balance is used appropriately.
Your API Credit balance is available using the
npx maslow get-api-client-info
command.
Once you purchased a MaslowGPT API subscription, the command below allows you to login to your MaslowGPT user account, via Google, so you can get your API Key loaded in MaslowGPT:
npx maslow login
Once you're logged in to your account, you're all set ! You're now ready to use all the powerful features of MaslowGPT.
When you have used all your initial API Credits, you can of course refill your API Credit Tank ;-)
To do so, use the following command:
npx maslow buy-api-credits
to purchase 5000 API Credits, for 5 USD (US Dollars) to get back into your work !
More refill options will be added over time.
Quick Note to the world: This is a work in progress, and also this is the beginning of my spiritual corporation 🌞 A worldwide company whose mission is to create a better education system. The poor quality of the current education system has taken a huge toll on my physical and mental health. To be honest, school literally almost killed me... This the reason why I want to create an ethical and spiritual enterprise that will make the world a measurably better place ! A place where the education system is doing it's job properly, A place that Abraham Maslow would be proud of ! So, I encourage you to subscribe to MaslowGPT. By doing so, you'll help yourself on your creative journey, and you'll help me build my ethical kingdom !!! Okay, enough pep talk. I'm a dreamer and an optimistic soul, and I want to provide value to the world 🌞
One last note: I'm French, and I learned English through Youtube videos, and movies, so if you see some weird uses of the English language, or some typos, in this README documentation, keep in mind I'm doing the best I can, please forgive me for my grammatical sins ;-) 🌞
Projects created with the help of MaslowGPT
This tool helped me a lot when I created the following apps and plugins:
A UEVR plugin allowing you to drive cars/boats/trucks using VR motion controls, accompanied by a tutorial describing how to setup VR support for Grand Theft Auto III: Definitive Edition
A UEVR plugin allowing you to drive cars/boats/trucks using VR motion controls, accompanied by a tutorial describing how to setup VR support for Grand Theft Auto Vice City: Definitive Edition
A UEVR plugin allowing you to drive cars/boats/trucks using VR motion controls, accompanied by a tutorial describing how to setup VR support for Grand Theft Auto San Andreas: Definitive Edition
A UEVR plugin allowing you to drive cars/boats/trucks using VR motion controls, in all UEVR compatible games
(any game created using Unreal Engine 4 / Unreal Engine 5)
You must subscribe to the maslowcorporation Google Group to be able to install the Pre Release version of the app.
An Android app that allows you to:
generate Arduino UNO programs from a text description of what you need (using ChatGPT) ,
Install these programs on Arduino UNO devices, thanks to a QR code scanning mechanism built-in the app, and thanks to the companion app called
ArduinoHex
Share these programs with others thanks to a QR code scanning mechanism built-in the app
(An IOS version of this app is coming soon ;-)
You must subscribe to the maslowcorporation Google Group to be able to install the Pre Release version of the app.
An Android app that ArduinoGPT needs, to install the Arduino programs on Arduino UNO devices, via USB/OTG
Quick Note about Free features
Please note that you can still use MaslowGPT without subscribing to the API.
You will be able to use the free features available, like The React Native app generation, or the npm package generation, etc....
And you'll get an error when you try to use the A.I. related stuff without an API Key ;-)
The
npx maslow
command displays a list of all the subcommands available, described in greater detail below.
All the MaslowGPT commands
ask-question 🌞
Allows you to ask a question to one of OpenAI's GPT models.
generate-code 🌞
Allows you to generate computer code, based on your description (the code's language, logic, etc...) , using one of OpenAI's GPT models.
This code is created in a folder/file specified by you.
make-code-fix 🌞
This command creates/updates the code_fix.txt
file in your code folder
(a code folder generated with generate-code
).
This code_fix.txt
file is where you can specify the fixes you want in your code.
regen-ai-code 🌞
Allows you to regenerate code quickly, based on whatever is in the code_fix.txt
file of your code folder.
(a code folder generated with generate-code
).
generate 🌞
Allows you to generate one of the following things:
- Generate a function, based on your description (the code's language, logic, etc...) , using one of OpenAI's GPT models.
This function is created in a folder/file specified by you. 🌞
- Generate a page in a React Native app (a React Native app created with the
create-react-native-app
command) 🌞
- Generate a subpage in a React Native app (a React Native app created with the
create-react-native-app
command) 🌞
- Generate a persistent SqliteRedux state in a React Native app (a React Native app created with the
create-react-native-app
command) 🌞
- Generate a multilingual string repository folder/file, in any Javascript/Typescript app 🌞
make-quick-fix 🌞
This command creates a prompts/get_quick_fix.txt
file in your function folder
(a function folder generated with generate
).
This prompts/get_quick_fix.txt
file is where you can specify the fixes you want in your function code.
regen-ai-func 🌞
Allows you to regenerate function code quickly, based on whatever is in the prompts/get_quick_fix.txt
file of your function folder.
(a function folder generated with generate
).
load-code-repo 🌞
Allows you to train the A.I. on your own codebase (Right now, this feature is limited to .js/.ts , .cpp and .py files, but very soon, lots of other languages will be supported ;-)
generate-code-from-repo 🌞
Allows you to generate code from the A.I. that learned from your codebase (Right now, this feature is limited to .js/.ts , .cpp and .py files, but very soon, lots of other languages will be supported ;-)
regen-repo-code 🌞
Allows you to regenerate function code quickly, based on whatever is in the prompts/get_quick_fix.txt
file of your function folder.
(a function folder generated with generate-code-from-repo
).
generate-art 🌞
Allows you to generate a picture from a text description.
generate-audio-from-text 🌞
Allows you to generate an audio message from a text prompt.
subscribe 🌞
Allows you to subscribe to the API of MaslowGPT, so you can use the A.I. powered tools.
This command gives you a choice between:
Subscribing using your Google account (recommended)
Subscribing anonymously
then gives you a URL link to the API subscription page.
The API access costs 15 USD (US Dollars). This gives you access to an API key, plus 5000 API Credits. The MaslowGPT API is usage based, so every time you make a request to MaslowGPT API, the associated cost is calculated, and your API Credit balance is used appropriately.
If you subscribed using a Google account, you can use the npx maslow login
command to load your API key automatically for you ;-)
Your API Credit balance is available using the
npx maslow get-api-client-info
command.
login 🌞
This command allows you to login to Google, so you can get your API Key loaded for you, if you subscribed using a Google account.
logout 🌞
This command allows you to logout from Google.
get-api-client-info 🌞
This command allows you to get your API client data, given the current API Key stored in MaslowGPT (with set-api-key
)
Among other things, this command lets you know how many API Credits you have left.
set-api-key 🌞
Allows you to set your API key in MaslowGPT. This key unlocks the powers of OpenAI ;-)
set-ai-model 🌞
Allows you to choose what OpenAI GPT model you want to use, when using the A.I. powered tools like ask-question
or generate-code
, etc....
buy-api-credits 🌞
Allows you to purchase 5000 API Credits, for 5 USD (US Dollars) to get back into your work !
create-react-native-app 🌞
Allows you to create a React Native application. To begin/continue/simplify your frontend developer journey !
add-ui 🌞
Allows you to add a user interface component, within a page of your React Native application
(A React Native app created with create-react-native-app
, and a page created with generate
).
create-backend-server 🌞
Allows you to create a backend server. To begin/continue/simplify your backend developer journey !
create-npm-package 🌞
Allows you to create a new NPM package, containing a Typescript SDK. To begin/continue/simplify your backend/frontend bridge builder journey ! ;-)
add-api-endpoint 🌞
Allows you to add an API endpoint, inside a backend server
(A backend server created with create-backend-server
)
add-sdk-method 🌞
Allows you to add a method to a SDK.
(A SDK created with create-npm-package
)
add-string 🌞
Allows you to add a string to a specified multingual string repository.
'multingual string repository'
AKA
- the AppStrings.js file in your generated React Native app,
or
- the AppStrings.js file in your generated backend server,
or
- the AppStrings.js file in your generated SDK,
or
- a multilingual repository file generated with
generate
translate-strings 🌞
Allows you to translate a multilingual repository from one language to another, using the powers of OpenAI.
duplicate-thing 🌞
Allows you to duplicate a specified folder/file.
delete-thing 🌞
Allows you to delete a specified folder/file.
create-readme-from-pics 🌞
Allows you to create a README_<random_uuid>.md
Skeleton from a specified folder containing photos/pictures.
upload-readme-pics 🌞
Allows you to create a README.md file identical to a given README.md file, but with all it's local photo assets uploaded to your own ImgBB account, and all the photo paths in this README turned to URLS.
(ImgBB accounts are free, and very simple to create !)
set-commands-folder 🌞
Allows you to set the folder containing your own custom commands, or the custom commands created by the MaslowGPT community.
run-command 🌞
Allows you to run a custom MaslowGPT command !
create-command 🌞
Allows you to create a custom MaslowGPT command that can:
create a folder from a template (useful for devs/game modders/etc...)
get input from the command user (with the help of a simple prompting mechanism. This is useful for the template creation mechanism, and also for the custom javascript program execution too)
Run custom Javascript code.
add-command-from-github 🌞
Allows you to add a custom command, created by someone in the MaslowGPT community, to your commands folder. The installation is done by cloning the given Github REPO URL, to your commands folder specified by npx maslow set-commands-folder
Let's put all these shiny tools to work !!! Let's create an awesome and educational project 🌞
Let's put this all together and show you the process of creating the following things:
- A sample Android/iOS app,
I called my mobile app RemindMe, This is a QNA app, powered with the magic of OPENAI.
- A backend server,
I called my server maslow-gpt-api-v2. This backend server powers the mobile app. This is also the same server that powers this MaslowGPT tool
(of course I added tons of other stuff in my server, like function generators, etc... Just like you will add tons of stuff in your own server, for your own purposes. Remember, the whole process below serves as a guideline, for your own adventure.)
- A npm package,
I called mine maslow-gpt-sdk. This SDK is a convienient bridge between the server and the mobile app.
The following steps illustrate the whole process.
The whole tutorial below serves as a guideline for you, adventurer ! You have a beautiful idea in your mind. It could be anything, a cooking recipe app, the next Uber for your country where there is no Uber (Many places have no Uber or UberEats, so I just gave you ideas ;-), a fantastic educational app dedicated to help people climb their way up Maslow's hierarchy of needs...... the list goes on.
Your bubbling/creative/restless mind is a powerful thing. ;-)
I want you to follow these steps, but don't forget that you're here to do your own thing, to create your own adventure. So, in your adventure, the app that you're about to create is maybe called 'DingleDong' or 'Cookbook', and your server may be called 'CookbookAPI'..... You get it, CUSTOMIZE this thing, this is your own Frankenstein, this is your ride, so pimp your ride !!
So create what you want to create, based on the creation process app described below. It's your adventure, you're the boss and the captain of the crew !!!
This app is destined to be available on both Android and IOS devices/emulators, but during the development of this app, we'll focus on Android first. We'll worry about IOS later.
Please note that the UI of the websites in this tutorial, are subjected to changes, so if the tutorial pictures don't match whatever the new UI is at the time of you reading this, then use common sense, and find the corresponding thing on the new webpage UI, Don't worry, be smart, use your neurons, drink water ;-)
1) React Native Setup: Follow this guide to set up your development environment. More info here: https://reactnative.dev/docs/environment-setup. 🌞
First, need to install all the stuff needed for React Native and Node.js development.
React Native Android Setup for Windows 10 (Local Build) 🌞
React Native Android Setup for Linux (Local Build) 🌞
React Native Android Setup for MacOS (Local Build) 🌞
2) Create the RemindMe (or Huber ? ;-) app, and install it on your Android device 🌞
Now, let's create an Android app.
3) Build your own UI: Generate the pages and templates you want in your RemindMe (or CookBook ? ;-) app 🌞
Now, let's create the UI (the User Interface) for this app.
4) Create the maslow-gpt-api-v2 server (or my-ultra-mega-server ? ;-) 🌞
Now, let's create the backend server that will skyrocket your app to new heights ;-)
5) Implement your backend features in RemindMe 🌞
Now, let's create a bridge between the backend server and the frontend (AKA your Android app) that will bring new powerz to your app ;-)
6) Get your backend server, and your Android app, ready for production 🌞
Now, let's serve your backend server and your Android app, to the world ;-)
7) Make a IOS version of your beloved app 🌞
Now, let's make a IOS version of your app, so Apple users don't feel neglected ;-)
TIPS AND TRICKS AND TROUBLESHOOT ;-) 🌞
Here you can get some tips and tricks, like how to set a debugger in your React Native app, etc....
If you have any question/issue, don't hesitate a second, and ask for help at
https://github.com/MaslowCorporation/MaslowGPT/issues
Me or someone else from the MaslowGPT community will be very happy to help you figure things out.
Right now, the Maslow community is just a dream, so I'll do my best to handle the bizness, but I believe in a future where the community will be huge. I'm talking about millions of users ! So, make my dream a reality, and create your dreams while you're helping me create mine ;-) Use this README as a reference, to guide you while you're creating your own apps, with the help of Mr. MaslowGPT. Enjoy creating with MaslowGPT and happy coding! 🎉🎊