enisn/abpdevtools/abpdev-environments

abpdev environments

Use this skill for env, envapp, and process environment switching.

Covered commands

Config file locations

Global configs are under:

%AppData%\abpdev

Main files in this area:

• EnvironmentConfiguration.yml via abpdev env config
• environment-tools.yml via abpdev envapp config
• tools-configuration.yml for terminal/open command overrides

Virtual environments

abpdev env config manages named sets of environment variables, mainly for connection strings.

Default environment names include:

• SqlServer
• MongoDb
• PostgreSql
• MySql

Example shape:

SqlServer:
  variables:
    ConnectionStrings__Default: Server=localhost;Database={AppName}_{Today};User ID=SA;Password=yourStrong(!)Password;TrustServerCertificate=True
 
MongoDb:
  variables:
    ConnectionStrings__Default: mongodb://localhost:27017/{AppName}_{Today}

Tokens like {AppName} and {Today} are intended for templated environment values.

Using an environment

Apply it directly while running:

abpdev run --env SqlServer
abpdev run --detach --env PostgreSql -p MyApp.HttpApi.Host

Or open a new terminal with that environment applied:

abpdev switch-to-env SqlServer

On Windows this uses the configured terminal command, which defaults to wt.

Environment apps

abpdev envapp start and abpdev envapp stop manage external infrastructure, usually through Docker commands stored in config.

Default app keys include:

• sqlserver
• sqlserver-edge
• postgresql
• mysql
• mongodb
• redis
• rabbitmq

Examples:

abpdev envapp start sqlserver
abpdev envapp start redis rabbitmq
abpdev envapp start sqlserver -p MyStrongPassword123! -v
abpdev envapp stop sqlserver
abpdev envapp stop all

Notes:

• envapp start can take multiple app names.
• Default development credentials are sa / yourStrong(!)Password for SQL Server, postgres / postgres for PostgreSQL, and root / root for MySQL.
• MongoDB and Redis keep the official images' passwordless defaults; RabbitMQ keeps guest / guest.
• -p, --password overrides the configured default and replaces the placeholder Passw0rd inside start commands.
• -v, --verbose shows Docker command output.
• envapp stop currently expects Docker-based stop commands.

Configuration format

abpdev envapp config opens a YAML dictionary keyed by app name.

Preferred schema:

sqlserver:
  DefaultPassword: yourStrong(!)Password
  start-cmds:
    - docker start tmp-sqlserver
    - docker run --name tmp-sqlserver --restart unless-stopped -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=Passw0rd" -p 1433:1433 -d mcr.microsoft.com/mssql/server:2017-CU8-ubuntu
  stop-cmds:
    - docker kill tmp-sqlserver
    - docker rm tmp-sqlserver

Legacy single-string keys are still supported, but arrays are preferred.

Guidance for agents

• Use abpdev run --env <name> when the user wants an environment only for that run.
• When an agent must continue working after launch, add --detach, then use abpdev ps --current --json to inspect readiness and abpdev stop for context-scoped cleanup.
• Use abpdev switch-to-env <name> when the user explicitly wants a shell/session switched.
• Use abpdev envapp start only for the infra tools the project actually needs.
• If the user is onboarding a project, abpdev prepare may be a better entry point because it can infer and start required env apps automatically.

Troubleshooting

App name is not recognized

• Run abpdev envapp config and verify the key name.

Wrong terminal opens for `switch-to-env`

• Check abpdev tools config and update the terminal tool path.

Docker command needs customization

• Edit environment-tools.yml via abpdev envapp config.