From 9d1442b46b2488bca7b2ced2467281da5390c5e4 Mon Sep 17 00:00:00 2001 From: mdnapo Date: Mon, 15 Jul 2024 00:14:21 +0200 Subject: [PATCH] Supplemented commands documentation --- MycroForge.CLI/Commands/MycroForge.Db.Stop.cs | 4 +-- .../Extensions/ServiceCollectionExtensions.cs | 4 +-- docs/docs/Commands/index.md | 25 ++++++++++++- docs/docs/Commands/init.md | 19 ---------- docs/docs/Commands/m4g_add/index.md | 22 ++++++++++++ docs/docs/Commands/m4g_add/m4g_add_api.md | 17 +++++++++ docs/docs/Commands/m4g_add/m4g_add_db.md | 18 ++++++++++ docs/docs/Commands/m4g_add/m4g_add_git.md | 16 +++++++++ .../Commands/m4g_add/m4g_add_gitignore.md | 16 +++++++++ docs/docs/Commands/m4g_api/index.md | 20 +++++++++++ .../m4g_api/m4g_api_generate/index.md | 20 +++++++++++ .../m4g_api_generate/m4g_api_generate_crud.md | 19 ++++++++++ .../m4g_api_generate_router.md | 19 ++++++++++ docs/docs/Commands/m4g_api/m4g_api_run.md | 16 +++++++++ docs/docs/Commands/m4g_db/index.md | 24 +++++++++++++ .../Commands/m4g_db/m4g_db_generate/index.md | 20 +++++++++++ .../m4g_db_generate/m4g_db_generate_entity.md | 35 +++++++++++++++++++ .../m4g_db_generate_migration.md | 19 ++++++++++ .../docs/Commands/m4g_db/m4g_db_link/index.md | 21 +++++++++++ .../m4g_db/m4g_db_link/m4g_db_link_many.md | 21 +++++++++++ .../m4g_db/m4g_db_link/m4g_db_link_one.md | 21 +++++++++++ docs/docs/Commands/m4g_db/m4g_db_migrate.md | 16 +++++++++ docs/docs/Commands/m4g_db/m4g_db_rollback.md | 16 +++++++++ docs/docs/Commands/m4g_db/m4g_db_run.md | 16 +++++++++ docs/docs/Commands/m4g_db/m4g_db_stop.md | 16 +++++++++ docs/docs/Commands/m4g_generate/index.md | 20 +++++++++++ .../m4g_generate/m4g_generate_service.md | 20 +++++++++++ .../m4g_generate/m4g_generate_vend.md | 16 +++++++++ docs/docs/Commands/m4g_hydrate.md | 16 +++++++++ docs/docs/Commands/m4g_init.md | 23 ++++++++++++ .../Commands/{install.md => m4g_install.md} | 2 +- docs/docs/Commands/m4g_plugin/index.md | 22 ++++++++++++ .../Commands/m4g_plugin/m4g_plugin_init.md | 19 ++++++++++ .../Commands/m4g_plugin/m4g_plugin_install.md | 17 +++++++++ .../Commands/m4g_plugin/m4g_plugin_list.md | 16 +++++++++ .../m4g_plugin/m4g_plugin_uninstall.md | 19 ++++++++++ docs/docs/Commands/m4g_uninstall.md | 20 +++++++++++ docs/docusaurus.config.ts | 2 +- 38 files changed, 646 insertions(+), 26 deletions(-) delete mode 100644 docs/docs/Commands/init.md create mode 100644 docs/docs/Commands/m4g_add/index.md create mode 100644 docs/docs/Commands/m4g_add/m4g_add_api.md create mode 100644 docs/docs/Commands/m4g_add/m4g_add_db.md create mode 100644 docs/docs/Commands/m4g_add/m4g_add_git.md create mode 100644 docs/docs/Commands/m4g_add/m4g_add_gitignore.md create mode 100644 docs/docs/Commands/m4g_api/index.md create mode 100644 docs/docs/Commands/m4g_api/m4g_api_generate/index.md create mode 100644 docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_crud.md create mode 100644 docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_router.md create mode 100644 docs/docs/Commands/m4g_api/m4g_api_run.md create mode 100644 docs/docs/Commands/m4g_db/index.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_generate/index.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_entity.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_migration.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_link/index.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_many.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_one.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_migrate.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_rollback.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_run.md create mode 100644 docs/docs/Commands/m4g_db/m4g_db_stop.md create mode 100644 docs/docs/Commands/m4g_generate/index.md create mode 100644 docs/docs/Commands/m4g_generate/m4g_generate_service.md create mode 100644 docs/docs/Commands/m4g_generate/m4g_generate_vend.md create mode 100644 docs/docs/Commands/m4g_hydrate.md create mode 100644 docs/docs/Commands/m4g_init.md rename docs/docs/Commands/{install.md => m4g_install.md} (89%) create mode 100644 docs/docs/Commands/m4g_plugin/index.md create mode 100644 docs/docs/Commands/m4g_plugin/m4g_plugin_init.md create mode 100644 docs/docs/Commands/m4g_plugin/m4g_plugin_install.md create mode 100644 docs/docs/Commands/m4g_plugin/m4g_plugin_list.md create mode 100644 docs/docs/Commands/m4g_plugin/m4g_plugin_uninstall.md create mode 100644 docs/docs/Commands/m4g_uninstall.md diff --git a/MycroForge.CLI/Commands/MycroForge.Db.Stop.cs b/MycroForge.CLI/Commands/MycroForge.Db.Stop.cs index a26739b..4677569 100644 --- a/MycroForge.CLI/Commands/MycroForge.Db.Stop.cs +++ b/MycroForge.CLI/Commands/MycroForge.Db.Stop.cs @@ -8,12 +8,12 @@ public partial class MycroForge { public partial class Db { - public partial class Stop : Command, ISubCommandOf + public class Stop : Command, ISubCommandOf { private readonly ProjectContext _context; public Stop(ProjectContext context) : - base("stop", $"Stops {Features.Db.FeatureName}.docker-compose.yml") + base("stop", $"Stops the services defined in {Features.Db.FeatureName}.docker-compose.yml") { _context = context; this.SetHandler(ExecuteAsync); diff --git a/MycroForge.CLI/Extensions/ServiceCollectionExtensions.cs b/MycroForge.CLI/Extensions/ServiceCollectionExtensions.cs index 1383627..9cd9d7b 100644 --- a/MycroForge.CLI/Extensions/ServiceCollectionExtensions.cs +++ b/MycroForge.CLI/Extensions/ServiceCollectionExtensions.cs @@ -10,13 +10,13 @@ public static class ServiceCollectionExtensions { public static IServiceCollection RegisterCommandDefaults(this IServiceCollection services) { - // Register ProjectContext & features + // Register ProjectContext, OptionsContainer & features services.AddScoped(); + services.AddScoped(); services.AddScoped(); services.AddScoped(); services.AddScoped(); services.AddScoped(); - services.AddScoped(); // Register "m4g" services.AddScoped(); diff --git a/docs/docs/Commands/index.md b/docs/docs/Commands/index.md index e682742..ff6c86d 100644 --- a/docs/docs/Commands/index.md +++ b/docs/docs/Commands/index.md @@ -1 +1,24 @@ -# Commands \ No newline at end of file +# Commands + +``` +Description: + The MycroForge CLI tool. + +Usage: + m4g [command] [options] + +Options: + --version Show version information + -?, -h, --help Show help and usage information + +Commands: + init Initialize a new project + i, install Install packages and update the requirements.txt + u, uninstall Uninstall packages and update the requirements.txt + hydrate Initialize venv and install dependencies from requirements.txt + add Add features to the project + g, generate Generate common items + api API related commands + db Database related commands + p, plugin Plugin related commands +``` \ No newline at end of file diff --git a/docs/docs/Commands/init.md b/docs/docs/Commands/init.md deleted file mode 100644 index 014c08f..0000000 --- a/docs/docs/Commands/init.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Init - -``` -Description: - Initialize a new project - -Usage: - m4g init [options] - -Arguments: - The name of your project - -Options: - --without Features to exclude - -?, -h, --help Show help and usage information diff --git a/docs/docs/Commands/m4g_add/index.md b/docs/docs/Commands/m4g_add/index.md new file mode 100644 index 0000000..efe3fa8 --- /dev/null +++ b/docs/docs/Commands/m4g_add/index.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +--- + +# m4g add + +``` +Description: + Add features to the project + +Usage: + m4g add [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + api Add FastAPI to the project + db Add SQLAlchemy & Alembic to the project + git Add git to the project + gitignore Add a default .gitignore file to the project +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_add/m4g_add_api.md b/docs/docs/Commands/m4g_add/m4g_add_api.md new file mode 100644 index 0000000..a3c46dd --- /dev/null +++ b/docs/docs/Commands/m4g_add/m4g_add_api.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 1 +--- + +# m4g add api + +``` +Description: + Add FastAPI to the project + +Usage: + m4g add api [options] + +Options: + --api-port The API port + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_add/m4g_add_db.md b/docs/docs/Commands/m4g_add/m4g_add_db.md new file mode 100644 index 0000000..7735ef2 --- /dev/null +++ b/docs/docs/Commands/m4g_add/m4g_add_db.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 1 +--- + +# m4g add db + +``` +Description: + Add SQLAlchemy & Alembic to the project + +Usage: + m4g add db [options] + +Options: + --database-host-port, --dbh-port The database host port + --database-ui-port, --dbu-port The database UI port + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_add/m4g_add_git.md b/docs/docs/Commands/m4g_add/m4g_add_git.md new file mode 100644 index 0000000..6a88edf --- /dev/null +++ b/docs/docs/Commands/m4g_add/m4g_add_git.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g add git + +``` +Description: + Add git to the project + +Usage: + m4g add git [options] + +Options: + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_add/m4g_add_gitignore.md b/docs/docs/Commands/m4g_add/m4g_add_gitignore.md new file mode 100644 index 0000000..c82e5d8 --- /dev/null +++ b/docs/docs/Commands/m4g_add/m4g_add_gitignore.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g add gitignore + +``` +Description: + Add a default .gitignore file to the project + +Usage: + m4g add gitignore [options] + +Options: + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_api/index.md b/docs/docs/Commands/m4g_api/index.md new file mode 100644 index 0000000..b3e44e9 --- /dev/null +++ b/docs/docs/Commands/m4g_api/index.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# m4g api + +``` +Description: + API related commands + +Usage: + m4g api [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + run Run your app + g, generate Generate an API item +``` diff --git a/docs/docs/Commands/m4g_api/m4g_api_generate/index.md b/docs/docs/Commands/m4g_api/m4g_api_generate/index.md new file mode 100644 index 0000000..d144af3 --- /dev/null +++ b/docs/docs/Commands/m4g_api/m4g_api_generate/index.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# m4g api generate + +``` +Description: + Generate an API item + +Usage: + m4g api generate [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + r, router Generate an api router + crud Generated CRUD functionality for an entity +``` diff --git a/docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_crud.md b/docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_crud.md new file mode 100644 index 0000000..6e32fc6 --- /dev/null +++ b/docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_crud.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# m4g api generate crud + +``` +Description: + Generated CRUD functionality for an entity + +Usage: + m4g api generate crud [options] + +Arguments: + The entity to target + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_router.md b/docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_router.md new file mode 100644 index 0000000..2ac6049 --- /dev/null +++ b/docs/docs/Commands/m4g_api/m4g_api_generate/m4g_api_generate_router.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# m4g api generate router + +``` +Description: + Generate an api router + +Usage: + m4g api generate router [options] + +Arguments: + The name of the api router + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_api/m4g_api_run.md b/docs/docs/Commands/m4g_api/m4g_api_run.md new file mode 100644 index 0000000..77e016a --- /dev/null +++ b/docs/docs/Commands/m4g_api/m4g_api_run.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g api run + +``` +Description: + Run your app + +Usage: + m4g api run [options] + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/index.md b/docs/docs/Commands/m4g_db/index.md new file mode 100644 index 0000000..bee16b7 --- /dev/null +++ b/docs/docs/Commands/m4g_db/index.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 1 +--- + +# m4g db + +``` +Description: + Database related commands + +Usage: + m4g db [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + run Runs the services defined in db.docker-compose.yml + stop Stops db.docker-compose.yml + migrate Apply migrations to the database + rollback Rollback the last migration + g, generate Generate a database item + link Define relationships between entities +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_generate/index.md b/docs/docs/Commands/m4g_db/m4g_db_generate/index.md new file mode 100644 index 0000000..ca29127 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_generate/index.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# m4g db generate + +``` +Description: + Generate a database item + +Usage: + m4g db generate [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + e, entity Generate and database entity + m, migration Generate a migration +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_entity.md b/docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_entity.md new file mode 100644 index 0000000..c37be12 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_entity.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# m4g db generate entity + +``` +Description: + Generate and database entity + +Usage: + m4g db generate entity [options] + +Arguments: + The name of the database entity + + Supported formats: + Entity + path/relative/to/entities:Entity + +Options: + -c, --column Specify the fields to add. + + Format: + :: + + = Name of the column + = The native Python type + = The SQLAlchemy type + + Example: + first_name:str:String(255) + -?, -h, --help Show help and usage information + +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_migration.md b/docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_migration.md new file mode 100644 index 0000000..90a495b --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_generate/m4g_db_generate_migration.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# m4g db generate migration + +``` +Description: + Generate a migration + +Usage: + m4g db generate migration [options] + +Arguments: + The name of the migration + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_link/index.md b/docs/docs/Commands/m4g_db/m4g_db_link/index.md new file mode 100644 index 0000000..7bc92db --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_link/index.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 1 +--- + +# m4g db link + +``` +Description: + Define relationships between entities + +Usage: + m4g db link [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + one Define a 1:n relation + many Define a n:m relation + +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_many.md b/docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_many.md new file mode 100644 index 0000000..11ea9b7 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_many.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 1 +--- + +# m4g db link many + +``` +Description: + Define a n:m relation + +Usage: + m4g db link many [options] + +Arguments: + The left side of the relation + +Options: + --to-one The right side of the relation + --to-many The right side of the relation + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_one.md b/docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_one.md new file mode 100644 index 0000000..9b7bf58 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_link/m4g_db_link_one.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 1 +--- + +# m4g db link one + +``` +Description: + Define a 1:n relation + +Usage: + m4g db link one [options] + +Arguments: + The left side of the relation + +Options: + --to-one The right side of the relation + --to-many The right side of the relation + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_migrate.md b/docs/docs/Commands/m4g_db/m4g_db_migrate.md new file mode 100644 index 0000000..427a2ae --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_migrate.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g db migrate + +``` +Description: + Apply migrations to the database + +Usage: + m4g db migrate [options] + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_rollback.md b/docs/docs/Commands/m4g_db/m4g_db_rollback.md new file mode 100644 index 0000000..9914fb5 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_rollback.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g db rollback + +``` +Description: + Rollback the last migration + +Usage: + m4g db rollback [options] + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_run.md b/docs/docs/Commands/m4g_db/m4g_db_run.md new file mode 100644 index 0000000..00c3d62 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_run.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g db run + +``` +Description: + Runs the services defined in db.docker-compose.yml + +Usage: + m4g db run [options] + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_db/m4g_db_stop.md b/docs/docs/Commands/m4g_db/m4g_db_stop.md new file mode 100644 index 0000000..86c0836 --- /dev/null +++ b/docs/docs/Commands/m4g_db/m4g_db_stop.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g db stop + +``` +Description: + Stops db.docker-compose.yml + +Usage: + m4g db stop [options] + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_generate/index.md b/docs/docs/Commands/m4g_generate/index.md new file mode 100644 index 0000000..7e2e388 --- /dev/null +++ b/docs/docs/Commands/m4g_generate/index.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# m4g generate + +``` +Description: + Generate common items + +Usage: + m4g generate [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + s, service Generate a service + venv Generate a venv +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_generate/m4g_generate_service.md b/docs/docs/Commands/m4g_generate/m4g_generate_service.md new file mode 100644 index 0000000..34e58ab --- /dev/null +++ b/docs/docs/Commands/m4g_generate/m4g_generate_service.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# m4g generate service + +``` +Description: + Generate a service + +Usage: + m4g generate service [options] + +Arguments: + The name of the service + +Options: + --with-session Create a service that uses database sessions + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_generate/m4g_generate_vend.md b/docs/docs/Commands/m4g_generate/m4g_generate_vend.md new file mode 100644 index 0000000..c80756e --- /dev/null +++ b/docs/docs/Commands/m4g_generate/m4g_generate_vend.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g generate venv + +``` +Description: + Generate a venv + +Usage: + m4g generate venv [options] + +Options: + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_hydrate.md b/docs/docs/Commands/m4g_hydrate.md new file mode 100644 index 0000000..6731d75 --- /dev/null +++ b/docs/docs/Commands/m4g_hydrate.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g hydrate + +``` +Description: + Initialize venv and install dependencies from requirements.txt + +Usage: + m4g hydrate [options] + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_init.md b/docs/docs/Commands/m4g_init.md new file mode 100644 index 0000000..0eaadea --- /dev/null +++ b/docs/docs/Commands/m4g_init.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +# m4g init + +``` +Description: + Initialize a new project + +Usage: + m4g init [options] + +Arguments: + The name of your project + +Options: + --without Features to exclude + --api-port The API port + --database-host-port, --dbh-port The database host port + --database-ui-port, --dbu-port The database UI port + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/install.md b/docs/docs/Commands/m4g_install.md similarity index 89% rename from docs/docs/Commands/install.md rename to docs/docs/Commands/m4g_install.md index f0015f2..fbe8370 100644 --- a/docs/docs/Commands/install.md +++ b/docs/docs/Commands/m4g_install.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Install +# m4g install ``` Description: diff --git a/docs/docs/Commands/m4g_plugin/index.md b/docs/docs/Commands/m4g_plugin/index.md new file mode 100644 index 0000000..e0b11fa --- /dev/null +++ b/docs/docs/Commands/m4g_plugin/index.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +--- + +# m4g plugin + +``` +Description: + Plugin related commands + +Usage: + m4g plugin [command] [options] + +Options: + -?, -h, --help Show help and usage information + +Commands: + init Initialize a basic plugin project + l, list, ls List all installed plugins + i, install Install a plugin + u, uninstall Uninstall a plugin +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_plugin/m4g_plugin_init.md b/docs/docs/Commands/m4g_plugin/m4g_plugin_init.md new file mode 100644 index 0000000..2d4bf47 --- /dev/null +++ b/docs/docs/Commands/m4g_plugin/m4g_plugin_init.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# m4g plugin init + +``` +Description: + Initialize a basic plugin project + +Usage: + m4g plugin init [options] + +Arguments: + The name of your project + +Options: + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_plugin/m4g_plugin_install.md b/docs/docs/Commands/m4g_plugin/m4g_plugin_install.md new file mode 100644 index 0000000..dbe0b86 --- /dev/null +++ b/docs/docs/Commands/m4g_plugin/m4g_plugin_install.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 1 +--- + +# m4g plugin install + +``` +Description: + Install a plugin + +Usage: + m4g plugin install [options] + +Options: + -p, --platform (REQUIRED) The platform to target when building the plugin + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_plugin/m4g_plugin_list.md b/docs/docs/Commands/m4g_plugin/m4g_plugin_list.md new file mode 100644 index 0000000..022d403 --- /dev/null +++ b/docs/docs/Commands/m4g_plugin/m4g_plugin_list.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +--- + +# m4g plugin list + +``` +Description: + List all installed plugins + +Usage: + m4g plugin list [options] + +Options: + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docs/Commands/m4g_plugin/m4g_plugin_uninstall.md b/docs/docs/Commands/m4g_plugin/m4g_plugin_uninstall.md new file mode 100644 index 0000000..8d4a388 --- /dev/null +++ b/docs/docs/Commands/m4g_plugin/m4g_plugin_uninstall.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# m4g plugin uninstall + +``` +Description: + Uninstall a plugin + +Usage: + m4g plugin uninstall [...] [options] + +Arguments: + The names of the plugins you want to uninstall + +Options: + -?, -h, --help Show help and usage information +``` diff --git a/docs/docs/Commands/m4g_uninstall.md b/docs/docs/Commands/m4g_uninstall.md new file mode 100644 index 0000000..2888ea0 --- /dev/null +++ b/docs/docs/Commands/m4g_uninstall.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# m4g uninstall + +``` +Description: + Uninstall packages and update the requirements.txt + +Usage: + m4g uninstall [...] [options] + +Arguments: + The names of the packages to uninstall + +Options: + -y, --yes Don’t ask for confirmation of uninstall deletions + -?, -h, --help Show help and usage information +``` \ No newline at end of file diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index ee89f2b..38d80d5 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -64,7 +64,7 @@ const config: Config = { label: 'Docs', }, { - href: 'https://git.devdisciples.com/devdisciplies/mycroforge', + href: 'https://git.devdisciples.com/devdisciples/mycroforge', label: 'Git', position: 'right', },