TypeScript
```typescript
type UserPromptSubmittedHandler = (
input: UserPromptSubmittedHookInput,
invocation: HookInvocation
) => Promise
;
```
Python
```python
UserPromptSubmittedHandler = Callable[
[UserPromptSubmittedHookInput, dict[str, str]],
Awaitable[UserPromptSubmittedHookOutput | None]
]
```
Go
```golang
type UserPromptSubmittedHandler func(
input UserPromptSubmittedHookInput,
invocation HookInvocation,
) (*UserPromptSubmittedHookOutput, error)
```
.NET
```csharp
public delegate Task
UserPromptSubmittedHandler(
UserPromptSubmittedHookInput input,
HookInvocation invocation);
```
Java
```java
@FunctionalInterface
public interface UserPromptSubmittedHandler {
CompletableFuture
handle(
UserPromptSubmittedHookInput input,
HookInvocation invocation);
}
```
## Input
| Field | Type | Description |
| ----------- | ------ | ------------------------------------------ |
| `timestamp` | number | Unix timestamp when the hook was triggered |
| `cwd` | string | Current working directory |
| `prompt` | string | The user's submitted prompt |
## Output
Return `null` or `undefined` to use the prompt unchanged. Otherwise, return an object with any of these fields:
| Field | Type | Description |
| ------------------- | ------- | ------------------------------------------------- |
| `modifiedPrompt` | string | Modified prompt to use instead of original |
| `additionalContext` | string | Extra context added to the conversation |
| `suppressOutput` | boolean | If true, suppress the assistant's response output |
## Examples
### Log all user prompts
TypeScript
```typescript
const session = await client.createSession({
hooks: {
onUserPromptSubmitted: async (input, invocation) => {
console.log(`[${invocation.sessionId}] User: ${input.prompt}`);
return null; // Pass through unchanged
},
},
});
```
Python
```python
from copilot.session import PermissionHandler
async def on_user_prompt_submitted(input_data, invocation):
print(f"[{invocation['session_id']}] User: {input_data['prompt']}")
return None
session = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={"on_user_prompt_submitted": on_user_prompt_submitted})
```
Go
```golang
session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{
Hooks: &copilot.SessionHooks{
OnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, inv copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {
fmt.Printf("[%s] User: %s\n", inv.SessionID, input.Prompt)
return nil, nil
},
},
})
```
.NET
```csharp
var session = await client.CreateSessionAsync(new SessionConfig
{
Hooks = new SessionHooks
{
OnUserPromptSubmitted = (input, invocation) =>
{
Console.WriteLine($"[{invocation.SessionId}] User: {input.Prompt}");
return Task.FromResult
(null);
},
},
});
```
Java
```java
import com.github.copilot.*;
import com.github.copilot.rpc.*;
import java.util.concurrent.CompletableFuture;
var hooks = new SessionHooks()
.setOnUserPromptSubmitted((input, invocation) -> {
System.out.println("[" + invocation.getSessionId() + "] User: " + input.prompt());
return CompletableFuture.completedFuture(null);
});
var session = client.createSession(
new SessionConfig()
.setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setHooks(hooks)
).get();
```
### Add project context
```typescript
const session = await client.createSession({
hooks: {
onUserPromptSubmitted: async (input) => {
const projectInfo = await getProjectInfo();
return {
additionalContext: `
Project: ${projectInfo.name}
Language: ${projectInfo.language}
Framework: ${projectInfo.framework}
`.trim(),
};
},
},
});
```
### Expand shorthand commands
```typescript
const SHORTCUTS: Record