am3

AM3 = Application Manager written with python 3

English | 中文

A command-line tool for managing and monitoring applications.

🦮 Table of Contents

• am3
  • 🦮 Table of Contents
  • 🔧 Installation
  • 📖 Basic Usage
    • List Applications
    • Start an Application
    • Stop an Application
    • Restart an Application
    • Delete an Application
    • View Logs
    • Save and Load Application List
  • ⚙️ Advanced Features
    • Configuration Files
    • Auto Restart
    • API Service
    • Startup on Boot
  • 🔄 Command Reference
    • Global Commands
    • Application Management Commands
    • API Service Commands
• 🙏 Acknowledgements

🔧 Installation

Python 3 is required, which should be available on most modern Linux distributions.

Install am3 with this command:

pip install am3

After installation, you can use either the am or am3 command.

---

📖 Basic Usage

List Applications

Retrieve and display information about running applications, including their name, ID, and other details.

am list
# or use the shorthand
am ls

Display more detailed information:

am list --all

---

Start an Application

There are multiple ways to start an application:

1. Start a registered application by ID

am start 0

2. Start a new application

am start --start "ping" --params "127.0.0.1"

3. Start using a configuration file

am start --conf example/counter_config.json

4. Start all applications

am start all

Start options:

• --start or -s: Specify the target path
• --interpreter or -i: Specify the interpreter path
• --working-directory or -d: Specify the working directory
• --params or -p: Specify command parameters
• --name or -n: Specify application name
• --restart-control/--no-restart-control: Control whether to restart the program

---

Stop an Application

Stop a running application by ID:

am stop 0

Stop all applications:

am stop all

---

Restart an Application

Restart a specific application by ID:

am restart 0

Restart all applications:

am restart all

---

Delete an Application

Remove an application from the management list:

am delete 0

Delete all applications (will prompt for confirmation):

am delete all

---

View Logs

View AM3's own logs:

am log

View logs for a specific application:

am log 0

Continuously view logs (similar to tail -f):

am log 0 --follow

Specify the number of lines to display:

am log 0 --lines 100

---

Save and Load Application List

Save the current application list configuration:

am save

Load application list from saved configuration:

am load

---

⚙️ Advanced Features

Configuration Files

You can save application configurations to a file for reuse:

am start --start example/counter.py --interpreter python3 --generate example/counter_config.json

Then start the application using the configuration file:

am start --conf example/counter_config.json

Auto Restart

AM3 supports automatic restart based on keywords or regular expressions:

am start --start example/counter.py --restart-keyword "Exception" --restart-keyword-regex "Error.*"

Set restart wait time:

am start --start example/counter.py --restart-wait-time 3

API Service

Initialize the API service:

am api init

Start the API service:

am api start

Stop the API service:

am api stop

Startup on Boot

Set AM3 to start on system boot:

am startup

---

🔄 Command Reference

Global Commands

• am --version: Display version information
• am --help: Display help information

Application Management Commands

• am list: List applications
• am start: Start an application
• am stop: Stop an application
• am restart: Restart an application
• am delete: Delete an application
• am log: View logs
• am save: Save application list
• am load: Load application list
• am startup: Set startup on boot

API Service Commands

• am api init: Initialize API service
• am api start: Start API service
• am api stop: Stop API service

---

🙏 Acknowledgements

Thanks for the great IDE Pycharm from Jetbrains.