Update README.md

Reviewed-on: Infendro/shell-kt#3

.gitea/workflows/main.yaml

@@ -1,36 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-
-env:
-  GIT__TOKEN: ${{ secrets.TOKEN }}
-
-jobs:
-  publish:
-    runs-on: linux
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/cache/restore@v4
-        with:
-          key: gradle
-          path: |
-            ~/.gradle/caches/
-            ~/.gradle/wrapper/
-            ~/.konan/
-
-      - uses: actions/setup-java@v4
-        with:
-          java-version: '24'
-          distribution: 'temurin'
-
-      - run: ./gradlew publish
-
-      - uses: actions/cache/save@v4
-        with:
-          key: gradle
-          path: |
-            ~/.gradle/caches/
-            ~/.gradle/wrapper/
-            ~/.konan/

.gitea/workflows/publish.yaml

@@ -0,0 +1,47 @@
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  publish:
+    runs-on: linux
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          java-version: '24'
+          distribution: 'temurin'
+
+      - name: Cache Gradle
+        uses: actions/cache@v4
+        with:
+          key: gradle-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: gradle
+          path: |
+            ~/.gradle/caches/
+            ~/.gradle/wrapper/
+
+      - name: Cache Konan
+        uses: actions/cache@v4
+        with:
+          key: konan-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: konan
+          path: |
+            ~/.konan/
+
+      - name: Cache Node
+        uses: actions/cache@v4
+        with:
+          key: node-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: node
+          path: |
+            ~/.gradle/nodejs
+            ~/.gradle/yarn
+
+      - name: Publish
+        run: ./gradlew publish
+        env:
+          INFENDRO__TOKEN: ${{ secrets.TOKEN }}

README.md

@@ -1,14 +1,6 @@
-# Kotlin Shell
+# shell.kt
 
-This library enables the execution of shell commands in Kotlin Multiplatform.
+`shell.kt` is a Kotlin Multiplatform library that enables the execution of shell commands.
-
-## Features
-
-* Execute commands on the shell.
-* Multiplatform support
-    * JVM
-    * JavaScript
-    * Native (Linux)
 
 ## Installation
 
@@ -20,21 +12,15 @@ repositories {
 }
 
 dependencies {
-    implementation("com.infendro:shell:1.0.0")
+    implementation("com.infendro:shell:1.1.0")
 }
 ```
 
 ## Usage
 
 ```kotlin
-import com.infendro.shell.Shell
+suspend fun main() {
-
+    val result = execute("echo", "Hello World!")
-fun main() {
-    // the command to execute
-    val command = arrayOf("echo", "Hello World!")
-
-    // execute the command
-    val result = Shell.run(command)
 
     println(result.code)  // 0
     println(result.value) // Hello World!

build.gradle.kts

@@ -1,54 +1,39 @@
-group = "com.infendro"
+import com.infendro.plugin.infendro
-version = "1.0.0"
+import com.infendro.plugin.token
 
-repositories {
+group = "com.infendro"
-    mavenCentral()
+version = "1.1.0"
-}
 
 plugins {
+    alias(libs.plugins.infendro)
     alias(libs.plugins.multiplatform)
     id("maven-publish")
 }
 
 kotlin {
     jvm()
-    js {
-        nodejs()
-    }
     linuxX64()
+    linuxArm64()
+    mingwX64()
+    macosX64()
+    macosArm64()
+    js { nodejs() }
+
+    repositories {
+        mavenCentral()
+    }
 
     sourceSets {
         jsMain.dependencies {
             implementation(libs.node)
         }
     }
-}
 
-publishing {
+    compilerOptions {
-    repositories {
+        freeCompilerArgs.add("-opt-in=kotlinx.cinterop.ExperimentalForeignApi")
-        maven {
-            url = uri("https://git.infendro.com/api/packages/Infendro/maven")
-            authentication.create("header", HttpHeaderAuthentication::class)
-            credentials(HttpHeaderCredentials::class) {
-                val token = secret("git.token") ?: throw GradleException()
-
-                name = "Authorization"
-                value = "token $token"
-            }
-        }
     }
 }
 
-fun secret(
+publishing.repositories {
-    key: String,
+    infendro(token)
-): String? {
-    val property = key
-    val environment = key
-        .uppercase()
-        .replace(".", "__")
-
-    val prop = properties[property] as String?
-    val env = System.getenv(environment)
-
-    return prop ?: env
 }

gradle/libs.versions.toml

@@ -1,8 +1,10 @@
 [versions]
-kotlin = "2.1.20"
+infendro = "1.1.0"
-node = "2025.6.9-22.13.10"
+kotlin = "2.3.0"
+node = "2026.2.11-24.10.4"
 
 [plugins]
+infendro = { id = "com.infendro.plugin", version.ref = "infendro" }
 multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 
 [libraries]

settings.gradle.kts

@@ -1 +1,6 @@
 rootProject.name = "shell"
+
+pluginManagement.repositories {
+    maven("https://git.infendro.com/api/packages/Infendro/maven")
+    mavenCentral()
+}

src/commonMain/kotlin/com/infendro/shell/Shell.kt

@@ -1,20 +1,20 @@
 package com.infendro.shell
 
-object Shell {
+data class Result(
-    suspend fun run(
-        command: Array<String>,
-        directory: String? = null,
-    ): Result {
-        return execute(command, directory)
-    }
-
-    class Result(
     val code: Int,
     val value: String,
-    )
+) {
+    val success: Boolean
+        get() = code == 0
+
+    internal companion object {
+        fun from(code: Int, value: String) = Result(code, value)
+
+        fun from(code: Int, success: () -> String, error: () -> String) = when (code) {
+            0 -> Result(code, success())
+            else -> Result(code, error())
+        }
+    }
 }
 
-internal expect suspend fun execute(
+expect suspend fun execute(vararg command: String, directory: String? = null): Result
-    command: Array<String>,
-    directory: String?,
-): Shell.Result

src/jsMain/kotlin/com/infendro/shell/Shell.js.kt

@@ -1,19 +1,17 @@
 package com.infendro.shell
 
-import kotlin.coroutines.resume
-import kotlin.coroutines.suspendCoroutine
 import node.childProcess.ExecOptions
 import node.childProcess.exec
+import kotlin.coroutines.resume
+import kotlin.coroutines.suspendCoroutine
 
-internal actual suspend fun execute(
+actual suspend fun execute(vararg command: String, directory: String?): Result = suspendCoroutine { continuation ->
-    command: Array<String>,
+    val command = command.joinToString(" ") { """"$it"""" }
-    directory: String?,
+    val options = ExecOptions(cwd = directory)
-): Shell.Result = suspendCoroutine { continuation ->
-    val command = command.joinToString(" ") { "\"$it\"" }
-    val options = ExecOptions.invoke(cwd = directory)
     exec(command, options) { error, stdout, stderr ->
-        val code = if (error == null) 0 else error.code!!.toInt()
+        val code = error?.code?.toInt() ?: 0
-        val value = if (error == null) stdout else stderr
+
-        continuation.resume(Shell.Result(code, value))
+        val result = Result.from(code, { stdout as String }, { stderr as String })
+        continuation.resume(result)
     }
 }

src/jvmMain/kotlin/com/infendro/shell/Shell.jvm.kt

@@ -1,21 +1,18 @@
 package com.infendro.shell
 
 import java.io.File
+import kotlin.coroutines.resume
+import kotlin.coroutines.suspendCoroutine
 
-internal actual suspend fun execute(
+actual suspend fun execute(vararg command: String, directory: String?): Result = suspendCoroutine { continuation ->
-    command: Array<String>,
+    val process = ProcessBuilder(*command).also {
-    directory: String?,
-): Shell.Result {
-    val process = ProcessBuilder(*command)
-        .also {
         if (directory != null) {
-                it.directory(File(directory))
+            val dir = File(directory)
+            it.directory(dir)
         }
-        }
+    }.start()
-        .start()
     val code = process.waitFor()
-    val value = process
+
-        .let { if (code == 0) it.inputReader() else it.errorReader() }
+    val result = Result.from(code, { process.inputReader().readText() }, { process.errorReader().readText() })
-        .readText()
+    continuation.resume(result)
-    return Shell.Result(code, value)
 }

src/linuxMain/kotlin/com/infendro/shell/Shell.linux.kt

@@ -0,0 +1,20 @@
+package com.infendro.shell
+
+import platform.posix.chdir
+import platform.posix.pclose
+import platform.posix.popen
+import kotlin.coroutines.resume
+import kotlin.coroutines.suspendCoroutine
+
+actual suspend fun execute(vararg command: String, directory: String?): Result = suspendCoroutine { continuation ->
+    val command = command.joinToString(" ") { """"$it"""" }
+    if (directory != null) {
+        chdir(directory)
+    }
+    val stream = popen(command, "r")!!
+    val value = stream.readLines().joinToString("")
+    val code = pclose(stream)
+
+    val result = Result.from(code, value)
+    continuation.resume(result)
+}

src/macosMain/kotlin/com/infendro/shell/Shell.macos.kt

@@ -0,0 +1,20 @@
+package com.infendro.shell
+
+import platform.posix.chdir
+import platform.posix.pclose
+import platform.posix.popen
+import kotlin.coroutines.resume
+import kotlin.coroutines.suspendCoroutine
+
+actual suspend fun execute(vararg command: String, directory: String?): Result = suspendCoroutine { continuation ->
+    val command = command.joinToString(" ") { """"$it"""" }
+    if (directory != null) {
+        chdir(directory)
+    }
+    val stream = popen(command, "r")!!
+    val value = stream.readLines().joinToString("")
+    val code = pclose(stream)
+
+    val result = Result.from(code, value)
+    continuation.resume(result)
+}

src/mingwMain/kotlin/shell/Shell.mingw.kt

@@ -0,0 +1,20 @@
+package com.infendro.shell
+
+import platform.posix._pclose
+import platform.posix._popen
+import platform.posix.chdir
+import kotlin.coroutines.resume
+import kotlin.coroutines.suspendCoroutine
+
+actual suspend fun execute(vararg command: String, directory: String?): Result = suspendCoroutine { continuation ->
+    val command = command.joinToString(" ") { """"$it"""" }
+    if (directory != null) {
+        chdir(directory)
+    }
+    val stream = _popen(command, "r")!!
+    val value = stream.readLines().joinToString("")
+    val code = _pclose(stream)
+
+    val result = Result.from(code, value)
+    continuation.resume(result)
+}

src/nativeMain/kotlin/com.infendro.shell/C.kt

@@ -0,0 +1,17 @@
+package com.infendro.shell
+
+import kotlinx.cinterop.CPointer
+import kotlinx.cinterop.refTo
+import kotlinx.cinterop.toKString
+import platform.posix.FILE
+import platform.posix.fgets
+
+internal fun CPointer<FILE>.readLines(): List<String> {
+    val lines = mutableListOf<String>()
+    val buffer = ByteArray(4096)
+    while (true) {
+        val line = fgets(buffer.refTo(0), buffer.size, this) ?: break
+        lines.add(line.toKString())
+    }
+    return lines
+}

src/nativeMain/kotlin/com/infendro/shell/Shell.native.kt

@@ -1,34 +0,0 @@
-package com.infendro.shell
-
-import kotlinx.cinterop.CPointer
-import kotlinx.cinterop.ExperimentalForeignApi
-import kotlinx.cinterop.refTo
-import kotlinx.cinterop.toKString
-import platform.posix.*
-
-@ExperimentalForeignApi
-internal actual suspend fun execute(
-    command: Array<String>,
-    directory: String?,
-): Shell.Result {
-    val command = command.joinToString(" ") { "\"$it\"" }
-    if (directory != null) {
-        chdir(directory)
-    }
-    val stream = popen(command, "r")!!
-    val value = stream.readLines().joinToString("")
-    val code = pclose(stream)
-    return Shell.Result(code, value)
-}
-
-@ExperimentalForeignApi
-private fun CPointer<FILE>.readLines(): List<String> {
-    val lines = mutableListOf<String>()
-    val buffer = ByteArray(4096)
-    while (true) {
-        val line = fgets(buffer.refTo(0), buffer.size, this)
-        if (line == null) break
-        lines.add(line.toKString())
-    }
-    return lines
-}