⚡ am-okay CLI

A portable command-line tool for copying and moving files and directories with progress indication.
Supports slot operations, default operations, cut & copy, progress bar, and JSON persistence.

---

📚 Summary

• Features
• Installation
• Use cases
  • Use cases (slot operations)
  • Use cases (default operations)
  • Use cases (filesystem information)
• About the Author
• License

✨ General features

• Prepare and execute copy and cut operations.
• Store operations in slots or use a default operation.
• Execute multiple operations at once.
• Reset or delete prepared operations.
• Provides a progress bar during file transfers.
• Persist prepared operations in JSON for later use.
• Fully portable CLI tool.
• Display detailed filesystem information (size, permissions, dates, ...etc) for files and directories.

💾 Installation

✅ Install via pip (recommended)

am-okay is published on PyPI and can be installed using the official Python package manager:

pip install am-okay

🛠️ Install from source via pip (quick development/test)

git clone https://github.com/baldeuniversel/am-okay.git
cd am-okay
pip install -r requirements.txt

🛠️ Install from source using Poetry (full development / contribution)

git clone https://github.com/baldeuniversel/am-okay.git
cd am-okay
poetry install
poetry run am-okay --help

---

🎯 Use cases

🔢 Use cases (slot operations)

Prepare a copy operation for the slot 0

am-okay --slot 0 --copy file1.txt file2.txt dirA

Prepare a cut operation for the slot 1

am-okay --slot 1 --cut dirB file3.txt

Print the prepared operation stored in the slot 0

am-okay --slot 0 --stat

Print prepared operations for slot indices from 0 to 1 (inclusive)

am-okay --slot 0-1 --stat

Print the prepared operations stored in slots 0 and 1

am-okay --slot 0,1 --stat

Print all the prepared operations stored in slots

am-okay --slot all --stat

Execute the prepared operation for the slot 0 (copy)

am-okay --slot 0 --paste dest/

Execute the prepared operation for the slot 1 (cut)

am-okay --slot 1 --paste dest/

Execute the prepared operations for slot indices from 0 to 1 (inclusive)

am-okay --slot 0-1 --paste dest/

Execute the prepared operations stored in slots 0 and 1

am-okay --slot 0,1 --paste dest/

Reset/delete the prepared operation for the slot 0

am-okay --slot 0 --reset

Reset/delete the prepared operations for slot indices from 0 to 1 (inclusive)

am-okay --slot 0-1 --reset

Reset/delete the prepared operations stored in slots 0 and 1

am-okay --slot 0,1 --reset

Reset/delete all prepared operations stored in the slots

am-okay --slot all --reset

🏷️ Use cases (default operations)

Prepare a copy operation

am-okay --copy file1.txt dirA

Prepare a cut operation

am-okay --copy file2.txt dirB

Execute the prepared default operation

am-okay --paste dest/

Print the prepared default operation

am-okay --stat

Reset/delete the prepared default operation

am-okay --reset

Immediate preparation and execution (copy)

am-okay --copy file3.txt dirC --paste dest/

Immediate preparation and execution (cut)

am-okay --cut file4.txt dirD --paste dest/

📁 Use cases (filesystem information)

Display information about a file

am-okay --info file5.txt

Display information about a directory

am-okay --info dirE

Display information about multiple files or directories

am-okay --info file6.txt dirF file7.txt dirG

---

👤 About the Author

Amadou Baldé
Developer/Programmer ... | Open Source Contributor

Connect with me:

• GitHub
• Email

Feel free to reach out if you'd like to collaborate on a project or discuss Python development !

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🔝 Back to top